src/libgame/setup.c

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  https://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // setup.c
  10 // ============================================================================
  11
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <dirent.h>
  15 #include <string.h>
  16 #include <unistd.h>
  17 #include <errno.h>
  18
  19 #include "platform.h"
  20
  21 #include "setup.h"
  22 #include "sound.h"
  23 #include "joystick.h"
  24 #include "text.h"
  25 #include "misc.h"
  26 #include "hash.h"
  27 #include "zip/miniunz.h"
  28
  29
  30 #define ENABLE_UNUSED_CODE      FALSE   // for currently unused functions
  31 #define DEBUG_NO_CONFIG_FILE    FALSE   // for extra-verbose debug output
  32
  33 #define NUM_LEVELCLASS_DESC     8
  34
  35 static char *levelclass_desc[NUM_LEVELCLASS_DESC] =
  36 {
  37   "Tutorial Levels",
  38   "Classic Originals",
  39   "Contributions",
  40   "Private Levels",
  41   "Boulderdash",
  42   "Emerald Mine",
  43   "Supaplex",
  44   "DX Boulderdash"
  45 };
  46
  47 #define TOKEN_VALUE_POSITION_SHORT              32
  48 #define TOKEN_VALUE_POSITION_DEFAULT            40
  49 #define TOKEN_COMMENT_POSITION_DEFAULT          60
  50
  51 #define TREE_NODE_TYPE_DEFAULT                  0
  52 #define TREE_NODE_TYPE_PARENT                   1
  53 #define TREE_NODE_TYPE_GROUP                    2
  54 #define TREE_NODE_TYPE_COPY                     3
  55
  56 #define TREE_NODE_TYPE(ti)      (ti->node_group  ? TREE_NODE_TYPE_GROUP  : \
  57                                  ti->parent_link ? TREE_NODE_TYPE_PARENT : \
  58                                  ti->is_copy     ? TREE_NODE_TYPE_COPY   : \
  59                                  TREE_NODE_TYPE_DEFAULT)
  60
  61
  62 static void setTreeInfoToDefaults(TreeInfo *, int);
  63 static TreeInfo *getTreeInfoCopy(TreeInfo *ti);
  64 static int compareTreeInfoEntries(const void *, const void *);
  65
  66 static int token_value_position   = TOKEN_VALUE_POSITION_DEFAULT;
  67 static int token_comment_position = TOKEN_COMMENT_POSITION_DEFAULT;
  68
  69 static SetupFileHash *artworkinfo_cache_old = NULL;
  70 static SetupFileHash *artworkinfo_cache_new = NULL;
  71 static SetupFileHash *optional_tokens_hash = NULL;
  72 static SetupFileHash *missing_file_hash = NULL;
  73 static boolean use_artworkinfo_cache = TRUE;
  74 static boolean update_artworkinfo_cache = FALSE;
  75
  76
  77 // ----------------------------------------------------------------------------
  78 // file functions
  79 // ----------------------------------------------------------------------------
  80
  81 static void WarnUsingFallback(char *filename)
  82 {
  83   if (getHashEntry(missing_file_hash, filename) == NULL)
  84   {
  85     setHashEntry(missing_file_hash, filename, "");
  86
  87     Debug("setup", "cannot find artwork file '%s' (using fallback)", filename);
  88   }
  89 }
  90
  91 static char *getLevelClassDescription(TreeInfo *ti)
  92 {
  93   int position = ti->sort_priority / 100;
  94
  95   if (position >= 0 && position < NUM_LEVELCLASS_DESC)
  96     return levelclass_desc[position];
  97   else
  98     return "Unknown Level Class";
  99 }
 100
 101 static char *getCacheDir(void)
 102 {
 103   static char *cache_dir = NULL;
 104
 105   if (cache_dir == NULL)
 106     cache_dir = getPath2(getMainUserGameDataDir(), CACHE_DIRECTORY);
 107
 108   return cache_dir;
 109 }
 110
 111 static char *getScoreDir(char *level_subdir)
 112 {
 113   static char *score_dir = NULL;
 114   static char *score_level_dir = NULL;
 115   char *score_subdir = SCORES_DIRECTORY;
 116
 117   if (score_dir == NULL)
 118     score_dir = getPath2(getMainUserGameDataDir(), score_subdir);
 119
 120   if (level_subdir != NULL)
 121   {
 122     checked_free(score_level_dir);
 123
 124     score_level_dir = getPath2(score_dir, level_subdir);
 125
 126     return score_level_dir;
 127   }
 128
 129   return score_dir;
 130 }
 131
 132 static char *getScoreCacheDir(char *level_subdir)
 133 {
 134   static char *score_dir = NULL;
 135   static char *score_level_dir = NULL;
 136   char *score_subdir = SCORES_DIRECTORY;
 137
 138   if (score_dir == NULL)
 139     score_dir = getPath2(getCacheDir(), score_subdir);
 140
 141   if (level_subdir != NULL)
 142   {
 143     checked_free(score_level_dir);
 144
 145     score_level_dir = getPath2(score_dir, level_subdir);
 146
 147     return score_level_dir;
 148   }
 149
 150   return score_dir;
 151 }
 152
 153 static char *getScoreTapeDir(char *level_subdir, int nr)
 154 {
 155   static char *score_tape_dir = NULL;
 156   char tape_subdir[MAX_FILENAME_LEN];
 157
 158   checked_free(score_tape_dir);
 159
 160   sprintf(tape_subdir, "%03d", nr);
 161   score_tape_dir = getPath2(getScoreDir(level_subdir), tape_subdir);
 162
 163   return score_tape_dir;
 164 }
 165
 166 static char *getScoreCacheTapeDir(char *level_subdir, int nr)
 167 {
 168   static char *score_cache_tape_dir = NULL;
 169   char tape_subdir[MAX_FILENAME_LEN];
 170
 171   checked_free(score_cache_tape_dir);
 172
 173   sprintf(tape_subdir, "%03d", nr);
 174   score_cache_tape_dir = getPath2(getScoreCacheDir(level_subdir), tape_subdir);
 175
 176   return score_cache_tape_dir;
 177 }
 178
 179 static char *getUserSubdir(int nr)
 180 {
 181   static char user_subdir[16] = { 0 };
 182
 183   sprintf(user_subdir, "%03d", nr);
 184
 185   return user_subdir;
 186 }
 187
 188 static char *getUserDir(int nr)
 189 {
 190   static char *user_dir = NULL;
 191   char *main_data_dir = getMainUserGameDataDir();
 192   char *users_subdir = USERS_DIRECTORY;
 193   char *user_subdir = getUserSubdir(nr);
 194
 195   checked_free(user_dir);
 196
 197   if (nr != -1)
 198     user_dir = getPath3(main_data_dir, users_subdir, user_subdir);
 199   else
 200     user_dir = getPath2(main_data_dir, users_subdir);
 201
 202   return user_dir;
 203 }
 204
 205 static char *getLevelSetupDir(char *level_subdir)
 206 {
 207   static char *levelsetup_dir = NULL;
 208   char *data_dir = getUserGameDataDir();
 209   char *levelsetup_subdir = LEVELSETUP_DIRECTORY;
 210
 211   checked_free(levelsetup_dir);
 212
 213   if (level_subdir != NULL)
 214     levelsetup_dir = getPath3(data_dir, levelsetup_subdir, level_subdir);
 215   else
 216     levelsetup_dir = getPath2(data_dir, levelsetup_subdir);
 217
 218   return levelsetup_dir;
 219 }
 220
 221 static char *getNetworkDir(void)
 222 {
 223   static char *network_dir = NULL;
 224
 225   if (network_dir == NULL)
 226     network_dir = getPath2(getMainUserGameDataDir(), NETWORK_DIRECTORY);
 227
 228   return network_dir;
 229 }
 230
 231 char *getLevelDirFromTreeInfo(TreeInfo *node)
 232 {
 233   static char *level_dir = NULL;
 234
 235   if (node == NULL)
 236     return options.level_directory;
 237
 238   checked_free(level_dir);
 239
 240   level_dir = getPath2((node->in_user_dir ? getUserLevelDir(NULL) :
 241                         options.level_directory), node->fullpath);
 242
 243   return level_dir;
 244 }
 245
 246 char *getUserLevelDir(char *level_subdir)
 247 {
 248   static char *userlevel_dir = NULL;
 249   char *data_dir = getMainUserGameDataDir();
 250   char *userlevel_subdir = LEVELS_DIRECTORY;
 251
 252   checked_free(userlevel_dir);
 253
 254   if (level_subdir != NULL)
 255     userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir);
 256   else
 257     userlevel_dir = getPath2(data_dir, userlevel_subdir);
 258
 259   return userlevel_dir;
 260 }
 261
 262 char *getNetworkLevelDir(char *level_subdir)
 263 {
 264   static char *network_level_dir = NULL;
 265   char *data_dir = getNetworkDir();
 266   char *networklevel_subdir = LEVELS_DIRECTORY;
 267
 268   checked_free(network_level_dir);
 269
 270   if (level_subdir != NULL)
 271     network_level_dir = getPath3(data_dir, networklevel_subdir, level_subdir);
 272   else
 273     network_level_dir = getPath2(data_dir, networklevel_subdir);
 274
 275   return network_level_dir;
 276 }
 277
 278 char *getCurrentLevelDir(void)
 279 {
 280   return getLevelDirFromTreeInfo(leveldir_current);
 281 }
 282
 283 char *getNewUserLevelSubdir(void)
 284 {
 285   static char *new_level_subdir = NULL;
 286   char *subdir_prefix = getLoginName();
 287   char subdir_suffix[10];
 288   int max_suffix_number = 1000;
 289   int i = 0;
 290
 291   while (++i < max_suffix_number)
 292   {
 293     sprintf(subdir_suffix, "_%d", i);
 294
 295     checked_free(new_level_subdir);
 296     new_level_subdir = getStringCat2(subdir_prefix, subdir_suffix);
 297
 298     if (!directoryExists(getUserLevelDir(new_level_subdir)))
 299       break;
 300   }
 301
 302   return new_level_subdir;
 303 }
 304
 305 char *getTapeDir(char *level_subdir)
 306 {
 307   static char *tape_dir = NULL;
 308   char *data_dir = getUserGameDataDir();
 309   char *tape_subdir = TAPES_DIRECTORY;
 310
 311   checked_free(tape_dir);
 312
 313   if (level_subdir != NULL)
 314     tape_dir = getPath3(data_dir, tape_subdir, level_subdir);
 315   else
 316     tape_dir = getPath2(data_dir, tape_subdir);
 317
 318   return tape_dir;
 319 }
 320
 321 static char *getSolutionTapeDir(void)
 322 {
 323   static char *tape_dir = NULL;
 324   char *data_dir = getCurrentLevelDir();
 325   char *tape_subdir = TAPES_DIRECTORY;
 326
 327   checked_free(tape_dir);
 328
 329   tape_dir = getPath2(data_dir, tape_subdir);
 330
 331   return tape_dir;
 332 }
 333
 334 static char *getDefaultGraphicsDir(char *graphics_subdir)
 335 {
 336   static char *graphics_dir = NULL;
 337
 338   if (graphics_subdir == NULL)
 339     return options.graphics_directory;
 340
 341   checked_free(graphics_dir);
 342
 343   graphics_dir = getPath2(options.graphics_directory, graphics_subdir);
 344
 345   return graphics_dir;
 346 }
 347
 348 static char *getDefaultSoundsDir(char *sounds_subdir)
 349 {
 350   static char *sounds_dir = NULL;
 351
 352   if (sounds_subdir == NULL)
 353     return options.sounds_directory;
 354
 355   checked_free(sounds_dir);
 356
 357   sounds_dir = getPath2(options.sounds_directory, sounds_subdir);
 358
 359   return sounds_dir;
 360 }
 361
 362 static char *getDefaultMusicDir(char *music_subdir)
 363 {
 364   static char *music_dir = NULL;
 365
 366   if (music_subdir == NULL)
 367     return options.music_directory;
 368
 369   checked_free(music_dir);
 370
 371   music_dir = getPath2(options.music_directory, music_subdir);
 372
 373   return music_dir;
 374 }
 375
 376 static char *getClassicArtworkSet(int type)
 377 {
 378   return (type == TREE_TYPE_GRAPHICS_DIR ? GFX_CLASSIC_SUBDIR :
 379           type == TREE_TYPE_SOUNDS_DIR   ? SND_CLASSIC_SUBDIR :
 380           type == TREE_TYPE_MUSIC_DIR    ? MUS_CLASSIC_SUBDIR : "");
 381 }
 382
 383 static char *getClassicArtworkDir(int type)
 384 {
 385   return (type == TREE_TYPE_GRAPHICS_DIR ?
 386           getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR) :
 387           type == TREE_TYPE_SOUNDS_DIR ?
 388           getDefaultSoundsDir(SND_CLASSIC_SUBDIR) :
 389           type == TREE_TYPE_MUSIC_DIR ?
 390           getDefaultMusicDir(MUS_CLASSIC_SUBDIR) : "");
 391 }
 392
 393 char *getUserGraphicsDir(void)
 394 {
 395   static char *usergraphics_dir = NULL;
 396
 397   if (usergraphics_dir == NULL)
 398     usergraphics_dir = getPath2(getMainUserGameDataDir(), GRAPHICS_DIRECTORY);
 399
 400   return usergraphics_dir;
 401 }
 402
 403 char *getUserSoundsDir(void)
 404 {
 405   static char *usersounds_dir = NULL;
 406
 407   if (usersounds_dir == NULL)
 408     usersounds_dir = getPath2(getMainUserGameDataDir(), SOUNDS_DIRECTORY);
 409
 410   return usersounds_dir;
 411 }
 412
 413 char *getUserMusicDir(void)
 414 {
 415   static char *usermusic_dir = NULL;
 416
 417   if (usermusic_dir == NULL)
 418     usermusic_dir = getPath2(getMainUserGameDataDir(), MUSIC_DIRECTORY);
 419
 420   return usermusic_dir;
 421 }
 422
 423 static char *getSetupArtworkDir(TreeInfo *ti)
 424 {
 425   static char *artwork_dir = NULL;
 426
 427   if (ti == NULL)
 428     return NULL;
 429
 430   checked_free(artwork_dir);
 431
 432   artwork_dir = getPath2(ti->basepath, ti->fullpath);
 433
 434   return artwork_dir;
 435 }
 436
 437 char *setLevelArtworkDir(TreeInfo *ti)
 438 {
 439   char **artwork_path_ptr, **artwork_set_ptr;
 440   TreeInfo *level_artwork;
 441
 442   if (ti == NULL || leveldir_current == NULL)
 443     return NULL;
 444
 445   artwork_path_ptr = LEVELDIR_ARTWORK_PATH_PTR(leveldir_current, ti->type);
 446   artwork_set_ptr  = LEVELDIR_ARTWORK_SET_PTR( leveldir_current, ti->type);
 447
 448   checked_free(*artwork_path_ptr);
 449
 450   if ((level_artwork = getTreeInfoFromIdentifier(ti, *artwork_set_ptr)))
 451   {
 452     *artwork_path_ptr = getStringCopy(getSetupArtworkDir(level_artwork));
 453   }
 454   else
 455   {
 456     /*
 457       No (or non-existing) artwork configured in "levelinfo.conf". This would
 458       normally result in using the artwork configured in the setup menu. But
 459       if an artwork subdirectory exists (which might contain custom artwork
 460       or an artwork configuration file), this level artwork must be treated
 461       as relative to the default "classic" artwork, not to the artwork that
 462       is currently configured in the setup menu.
 463
 464       Update: For "special" versions of R'n'D (like "R'n'D jue"), do not use
 465       the "default" artwork (which would be "jue0" for "R'n'D jue"), but use
 466       the real "classic" artwork from the original R'n'D (like "gfx_classic").
 467     */
 468
 469     char *dir = getPath2(getCurrentLevelDir(), ARTWORK_DIRECTORY(ti->type));
 470
 471     checked_free(*artwork_set_ptr);
 472
 473     if (directoryExists(dir))
 474     {
 475       *artwork_path_ptr = getStringCopy(getClassicArtworkDir(ti->type));
 476       *artwork_set_ptr = getStringCopy(getClassicArtworkSet(ti->type));
 477     }
 478     else
 479     {
 480       *artwork_path_ptr = getStringCopy(UNDEFINED_FILENAME);
 481       *artwork_set_ptr = NULL;
 482     }
 483
 484     free(dir);
 485   }
 486
 487   return *artwork_set_ptr;
 488 }
 489
 490 static char *getLevelArtworkSet(int type)
 491 {
 492   if (leveldir_current == NULL)
 493     return NULL;
 494
 495   return LEVELDIR_ARTWORK_SET(leveldir_current, type);
 496 }
 497
 498 static char *getLevelArtworkDir(int type)
 499 {
 500   if (leveldir_current == NULL)
 501     return UNDEFINED_FILENAME;
 502
 503   return LEVELDIR_ARTWORK_PATH(leveldir_current, type);
 504 }
 505
 506 char *getProgramMainDataPath(char *command_filename, char *base_path)
 507 {
 508   // check if the program's main data base directory is configured
 509   if (!strEqual(base_path, "."))
 510     return getStringCopy(base_path);
 511
 512   /* if the program is configured to start from current directory (default),
 513      determine program package directory from program binary (some versions
 514      of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
 515      set the current working directory to the program package directory) */
 516   char *main_data_path = getBasePath(command_filename);
 517
 518 #if defined(PLATFORM_MAC)
 519   if (strSuffix(main_data_path, MAC_APP_BINARY_SUBDIR))
 520   {
 521     char *main_data_path_old = main_data_path;
 522
 523     // cut relative path to Mac OS X application binary directory from path
 524     main_data_path[strlen(main_data_path) -
 525                    strlen(MAC_APP_BINARY_SUBDIR)] = '\0';
 526
 527     // cut trailing path separator from path (but not if path is root directory)
 528     if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
 529       main_data_path[strlen(main_data_path) - 1] = '\0';
 530
 531     // replace empty path with current directory
 532     if (strEqual(main_data_path, ""))
 533       main_data_path = ".";
 534
 535     // add relative path to Mac OS X application resources directory to path
 536     main_data_path = getPath2(main_data_path, MAC_APP_FILES_SUBDIR);
 537
 538     free(main_data_path_old);
 539   }
 540 #endif
 541
 542   return main_data_path;
 543 }
 544
 545 char *getProgramConfigFilename(char *command_filename)
 546 {
 547   static char *config_filename_1 = NULL;
 548   static char *config_filename_2 = NULL;
 549   static char *config_filename_3 = NULL;
 550   static boolean initialized = FALSE;
 551
 552   if (!initialized)
 553   {
 554     char *command_filename_1 = getStringCopy(command_filename);
 555
 556     // strip trailing executable suffix from command filename
 557     if (strSuffix(command_filename_1, ".exe"))
 558       command_filename_1[strlen(command_filename_1) - 4] = '\0';
 559
 560     char *base_path = getProgramMainDataPath(command_filename, BASE_PATH);
 561     char *conf_directory = getPath2(base_path, CONF_DIRECTORY);
 562
 563     char *command_basepath = getBasePath(command_filename);
 564     char *command_basename = getBaseNameNoSuffix(command_filename);
 565     char *command_filename_2 = getPath2(command_basepath, command_basename);
 566
 567     config_filename_1 = getStringCat2(command_filename_1, ".conf");
 568     config_filename_2 = getStringCat2(command_filename_2, ".conf");
 569     config_filename_3 = getPath2(conf_directory, SETUP_FILENAME);
 570
 571     checked_free(base_path);
 572     checked_free(conf_directory);
 573
 574     checked_free(command_basepath);
 575     checked_free(command_basename);
 576
 577     checked_free(command_filename_1);
 578     checked_free(command_filename_2);
 579
 580     initialized = TRUE;
 581   }
 582
 583   // 1st try: look for config file that exactly matches the binary filename
 584   if (fileExists(config_filename_1))
 585     return config_filename_1;
 586
 587   // 2nd try: look for config file that matches binary filename without suffix
 588   if (fileExists(config_filename_2))
 589     return config_filename_2;
 590
 591   // 3rd try: return setup config filename in global program config directory
 592   return config_filename_3;
 593 }
 594
 595 static char *getPlatformConfigFilename(char *config_filename)
 596 {
 597   static char *platform_config_filename = NULL;
 598   static boolean initialized = FALSE;
 599
 600   if (!initialized)
 601   {
 602     char *config_basepath = getBasePath(config_filename);
 603     char *config_basename = getBaseNameNoSuffix(config_filename);
 604     char *config_filename_prefix = getPath2(config_basepath, config_basename);
 605     char *platform_string_lower = getStringToLower(PLATFORM_STRING);
 606     char *platform_suffix = getStringCat2("-", platform_string_lower);
 607
 608     platform_config_filename = getStringCat3(config_filename_prefix,
 609                                              platform_suffix, ".conf");
 610
 611     checked_free(config_basepath);
 612     checked_free(config_basename);
 613     checked_free(config_filename_prefix);
 614     checked_free(platform_string_lower);
 615     checked_free(platform_suffix);
 616
 617     initialized = TRUE;
 618   }
 619
 620   return platform_config_filename;
 621 }
 622
 623 char *getTapeFilename(int nr)
 624 {
 625   static char *filename = NULL;
 626   char basename[MAX_FILENAME_LEN];
 627
 628   checked_free(filename);
 629
 630   sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION);
 631   filename = getPath2(getTapeDir(leveldir_current->subdir), basename);
 632
 633   return filename;
 634 }
 635
 636 char *getTemporaryTapeFilename(void)
 637 {
 638   static char *filename = NULL;
 639   char basename[MAX_FILENAME_LEN];
 640
 641   checked_free(filename);
 642
 643   sprintf(basename, "tmp.%s", TAPEFILE_EXTENSION);
 644   filename = getPath2(getTapeDir(NULL), basename);
 645
 646   return filename;
 647 }
 648
 649 char *getDefaultSolutionTapeFilename(int nr)
 650 {
 651   static char *filename = NULL;
 652   char basename[MAX_FILENAME_LEN];
 653
 654   checked_free(filename);
 655
 656   sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION);
 657   filename = getPath2(getSolutionTapeDir(), basename);
 658
 659   return filename;
 660 }
 661
 662 char *getSokobanSolutionTapeFilename(int nr)
 663 {
 664   static char *filename = NULL;
 665   char basename[MAX_FILENAME_LEN];
 666
 667   checked_free(filename);
 668
 669   sprintf(basename, "%03d.sln", nr);
 670   filename = getPath2(getSolutionTapeDir(), basename);
 671
 672   return filename;
 673 }
 674
 675 char *getSolutionTapeFilename(int nr)
 676 {
 677   char *filename = getDefaultSolutionTapeFilename(nr);
 678
 679   if (!fileExists(filename))
 680   {
 681     char *filename2 = getSokobanSolutionTapeFilename(nr);
 682
 683     if (fileExists(filename2))
 684       return filename2;
 685   }
 686
 687   return filename;
 688 }
 689
 690 char *getScoreFilename(int nr)
 691 {
 692   static char *filename = NULL;
 693   char basename[MAX_FILENAME_LEN];
 694
 695   checked_free(filename);
 696
 697   sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION);
 698
 699   // used instead of "leveldir_current->subdir" (for network games)
 700   filename = getPath2(getScoreDir(levelset.identifier), basename);
 701
 702   return filename;
 703 }
 704
 705 char *getScoreCacheFilename(int nr)
 706 {
 707   static char *filename = NULL;
 708   char basename[MAX_FILENAME_LEN];
 709
 710   checked_free(filename);
 711
 712   sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION);
 713
 714   // used instead of "leveldir_current->subdir" (for network games)
 715   filename = getPath2(getScoreCacheDir(levelset.identifier), basename);
 716
 717   return filename;
 718 }
 719
 720 char *getScoreTapeBasename(char *name)
 721 {
 722   static char basename[MAX_FILENAME_LEN];
 723   char basename_raw[MAX_FILENAME_LEN];
 724   char timestamp[20];
 725
 726   sprintf(timestamp, "%s", getCurrentTimestamp());
 727   sprintf(basename_raw, "%s-%s", timestamp, name);
 728   sprintf(basename, "%s-%08x", timestamp, get_hash_from_string(basename_raw));
 729
 730   return basename;
 731 }
 732
 733 char *getScoreTapeFilename(char *basename_no_ext, int nr)
 734 {
 735   static char *filename = NULL;
 736   char basename[MAX_FILENAME_LEN];
 737
 738   checked_free(filename);
 739
 740   sprintf(basename, "%s.%s", basename_no_ext, TAPEFILE_EXTENSION);
 741
 742   // used instead of "leveldir_current->subdir" (for network games)
 743   filename = getPath2(getScoreTapeDir(levelset.identifier, nr), basename);
 744
 745   return filename;
 746 }
 747
 748 char *getScoreCacheTapeFilename(char *basename_no_ext, int nr)
 749 {
 750   static char *filename = NULL;
 751   char basename[MAX_FILENAME_LEN];
 752
 753   checked_free(filename);
 754
 755   sprintf(basename, "%s.%s", basename_no_ext, TAPEFILE_EXTENSION);
 756
 757   // used instead of "leveldir_current->subdir" (for network games)
 758   filename = getPath2(getScoreCacheTapeDir(levelset.identifier, nr), basename);
 759
 760   return filename;
 761 }
 762
 763 char *getSetupFilename(void)
 764 {
 765   static char *filename = NULL;
 766
 767   checked_free(filename);
 768
 769   filename = getPath2(getSetupDir(), SETUP_FILENAME);
 770
 771   return filename;
 772 }
 773
 774 char *getDefaultSetupFilename(void)
 775 {
 776   return program.config_filename;
 777 }
 778
 779 char *getPlatformSetupFilename(void)
 780 {
 781   return getPlatformConfigFilename(program.config_filename);
 782 }
 783
 784 char *getEditorSetupFilename(void)
 785 {
 786   static char *filename = NULL;
 787
 788   checked_free(filename);
 789   filename = getPath2(getCurrentLevelDir(), EDITORSETUP_FILENAME);
 790
 791   if (fileExists(filename))
 792     return filename;
 793
 794   checked_free(filename);
 795   filename = getPath2(getSetupDir(), EDITORSETUP_FILENAME);
 796
 797   return filename;
 798 }
 799
 800 char *getHelpAnimFilename(void)
 801 {
 802   static char *filename = NULL;
 803
 804   checked_free(filename);
 805
 806   filename = getPath2(getCurrentLevelDir(), HELPANIM_FILENAME);
 807
 808   return filename;
 809 }
 810
 811 char *getHelpTextFilename(void)
 812 {
 813   static char *filename = NULL;
 814
 815   checked_free(filename);
 816
 817   filename = getPath2(getCurrentLevelDir(), HELPTEXT_FILENAME);
 818
 819   return filename;
 820 }
 821
 822 static char *getLevelSetInfoBasename(int nr)
 823 {
 824   static char basename[32];
 825
 826   sprintf(basename, "levelset_%d.txt", nr + 1);
 827
 828   return basename;
 829 }
 830
 831 char *getLevelSetInfoFilename(int nr)
 832 {
 833   char *basename = getLevelSetInfoBasename(nr);
 834   static char *info_subdir = NULL;
 835   static char *filename = NULL;
 836
 837   if (info_subdir == NULL)
 838     info_subdir = getPath2(DOCS_DIRECTORY, LEVELSET_INFO_DIRECTORY);
 839
 840   checked_free(filename);
 841
 842   // look for level set info file the current level set directory
 843   filename = getPath3(getCurrentLevelDir(), info_subdir, basename);
 844   if (fileExists(filename))
 845     return filename;
 846
 847   if (nr > 0)
 848     return NULL;
 849
 850   char *basenames[] =
 851   {
 852     "README",
 853     "README.TXT",
 854     "README.txt",
 855     "Readme",
 856     "Readme.txt",
 857     "readme",
 858     "readme.txt",
 859
 860     NULL
 861   };
 862   int i;
 863
 864   for (i = 0; basenames[i] != NULL; i++)
 865   {
 866     checked_free(filename);
 867     filename = getPath2(getCurrentLevelDir(), basenames[i]);
 868
 869     if (fileExists(filename))
 870       return filename;
 871   }
 872
 873   return NULL;
 874 }
 875
 876 static char *getLevelSetTitleMessageBasename(int nr, boolean initial)
 877 {
 878   static char basename[32];
 879
 880   sprintf(basename, "%s_%d.txt",
 881           (initial ? "titlemessage_initial" : "titlemessage"), nr + 1);
 882
 883   return basename;
 884 }
 885
 886 char *getLevelSetTitleMessageFilename(int nr, boolean initial)
 887 {
 888   static char *filename = NULL;
 889   char *basename;
 890   boolean skip_setup_artwork = FALSE;
 891
 892   checked_free(filename);
 893
 894   basename = getLevelSetTitleMessageBasename(nr, initial);
 895
 896   if (!gfx.override_level_graphics)
 897   {
 898     // 1st try: look for special artwork in current level series directory
 899     filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename);
 900     if (fileExists(filename))
 901       return filename;
 902
 903     free(filename);
 904
 905     // 2nd try: look for message file in current level set directory
 906     filename = getPath2(getCurrentLevelDir(), basename);
 907     if (fileExists(filename))
 908       return filename;
 909
 910     free(filename);
 911
 912     // check if there is special artwork configured in level series config
 913     if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL)
 914     {
 915       // 3rd try: look for special artwork configured in level series config
 916       filename = getPath2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename);
 917       if (fileExists(filename))
 918         return filename;
 919
 920       free(filename);
 921
 922       // take missing artwork configured in level set config from default
 923       skip_setup_artwork = TRUE;
 924     }
 925   }
 926
 927   if (!skip_setup_artwork)
 928   {
 929     // 4th try: look for special artwork in configured artwork directory
 930     filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename);
 931     if (fileExists(filename))
 932       return filename;
 933
 934     free(filename);
 935   }
 936
 937   // 5th try: look for default artwork in new default artwork directory
 938   filename = getPath2(getDefaultGraphicsDir(GFX_DEFAULT_SUBDIR), basename);
 939   if (fileExists(filename))
 940     return filename;
 941
 942   free(filename);
 943
 944   // 6th try: look for default artwork in old default artwork directory
 945   filename = getPath2(options.graphics_directory, basename);
 946   if (fileExists(filename))
 947     return filename;
 948
 949   return NULL;          // cannot find specified artwork file anywhere
 950 }
 951
 952 static char *getCreditsBasename(int nr)
 953 {
 954   static char basename[32];
 955
 956   sprintf(basename, "credits_%d.txt", nr + 1);
 957
 958   return basename;
 959 }
 960
 961 char *getCreditsFilename(int nr, boolean global)
 962 {
 963   char *basename = getCreditsBasename(nr);
 964   char *basepath = NULL;
 965   static char *credits_subdir = NULL;
 966   static char *filename = NULL;
 967
 968   if (credits_subdir == NULL)
 969     credits_subdir = getPath2(DOCS_DIRECTORY, CREDITS_DIRECTORY);
 970
 971   checked_free(filename);
 972
 973   // look for credits file in the game's base or current level set directory
 974   basepath = (global ? options.base_directory : getCurrentLevelDir());
 975
 976   filename = getPath3(basepath, credits_subdir, basename);
 977   if (fileExists(filename))
 978     return filename;
 979
 980   return NULL;          // cannot find credits file
 981 }
 982
 983 static char *getProgramInfoBasename(int nr)
 984 {
 985   static char basename[32];
 986
 987   sprintf(basename, "program_%d.txt", nr + 1);
 988
 989   return basename;
 990 }
 991
 992 char *getProgramInfoFilename(int nr)
 993 {
 994   char *basename = getProgramInfoBasename(nr);
 995   static char *info_subdir = NULL;
 996   static char *filename = NULL;
 997
 998   if (info_subdir == NULL)
 999     info_subdir = getPath2(DOCS_DIRECTORY, PROGRAM_INFO_DIRECTORY);
1000
1001   checked_free(filename);
1002
1003   // look for program info file in the game's base directory
1004   filename = getPath3(options.base_directory, info_subdir, basename);
1005   if (fileExists(filename))
1006     return filename;
1007
1008   return NULL;          // cannot find program info file
1009 }
1010
1011 static char *getCorrectedArtworkBasename(char *basename)
1012 {
1013   return basename;
1014 }
1015
1016 char *getCustomImageFilename(char *basename)
1017 {
1018   static char *filename = NULL;
1019   boolean skip_setup_artwork = FALSE;
1020
1021   checked_free(filename);
1022
1023   basename = getCorrectedArtworkBasename(basename);
1024
1025   if (!gfx.override_level_graphics)
1026   {
1027     // 1st try: look for special artwork in current level series directory
1028     filename = getImg3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename);
1029     if (fileExists(filename))
1030       return filename;
1031
1032     free(filename);
1033
1034     // check if there is special artwork configured in level series config
1035     if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL)
1036     {
1037       // 2nd try: look for special artwork configured in level series config
1038       filename = getImg2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename);
1039       if (fileExists(filename))
1040         return filename;
1041
1042       free(filename);
1043
1044       // take missing artwork configured in level set config from default
1045       skip_setup_artwork = TRUE;
1046     }
1047   }
1048
1049   if (!skip_setup_artwork)
1050   {
1051     // 3rd try: look for special artwork in configured artwork directory
1052     filename = getImg2(getSetupArtworkDir(artwork.gfx_current), basename);
1053     if (fileExists(filename))
1054       return filename;
1055
1056     free(filename);
1057   }
1058
1059   // 4th try: look for default artwork in new default artwork directory
1060   filename = getImg2(getDefaultGraphicsDir(GFX_DEFAULT_SUBDIR), basename);
1061   if (fileExists(filename))
1062     return filename;
1063
1064   free(filename);
1065
1066   // 5th try: look for default artwork in old default artwork directory
1067   filename = getImg2(options.graphics_directory, basename);
1068   if (fileExists(filename))
1069     return filename;
1070
1071   if (!strEqual(GFX_FALLBACK_FILENAME, UNDEFINED_FILENAME))
1072   {
1073     free(filename);
1074
1075     WarnUsingFallback(basename);
1076
1077     // 6th try: look for fallback artwork in old default artwork directory
1078     // (needed to prevent errors when trying to access unused artwork files)
1079     filename = getImg2(options.graphics_directory, GFX_FALLBACK_FILENAME);
1080     if (fileExists(filename))
1081       return filename;
1082   }
1083
1084   return NULL;          // cannot find specified artwork file anywhere
1085 }
1086
1087 char *getCustomSoundFilename(char *basename)
1088 {
1089   static char *filename = NULL;
1090   boolean skip_setup_artwork = FALSE;
1091
1092   checked_free(filename);
1093
1094   basename = getCorrectedArtworkBasename(basename);
1095
1096   if (!gfx.override_level_sounds)
1097   {
1098     // 1st try: look for special artwork in current level series directory
1099     filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename);
1100     if (fileExists(filename))
1101       return filename;
1102
1103     free(filename);
1104
1105     // check if there is special artwork configured in level series config
1106     if (getLevelArtworkSet(ARTWORK_TYPE_SOUNDS) != NULL)
1107     {
1108       // 2nd try: look for special artwork configured in level series config
1109       filename = getPath2(getLevelArtworkDir(TREE_TYPE_SOUNDS_DIR), basename);
1110       if (fileExists(filename))
1111         return filename;
1112
1113       free(filename);
1114
1115       // take missing artwork configured in level set config from default
1116       skip_setup_artwork = TRUE;
1117     }
1118   }
1119
1120   if (!skip_setup_artwork)
1121   {
1122     // 3rd try: look for special artwork in configured artwork directory
1123     filename = getPath2(getSetupArtworkDir(artwork.snd_current), basename);
1124     if (fileExists(filename))
1125       return filename;
1126
1127     free(filename);
1128   }
1129
1130   // 4th try: look for default artwork in new default artwork directory
1131   filename = getPath2(getDefaultSoundsDir(SND_DEFAULT_SUBDIR), basename);
1132   if (fileExists(filename))
1133     return filename;
1134
1135   free(filename);
1136
1137   // 5th try: look for default artwork in old default artwork directory
1138   filename = getPath2(options.sounds_directory, basename);
1139   if (fileExists(filename))
1140     return filename;
1141
1142   if (!strEqual(SND_FALLBACK_FILENAME, UNDEFINED_FILENAME))
1143   {
1144     free(filename);
1145
1146     WarnUsingFallback(basename);
1147
1148     // 6th try: look for fallback artwork in old default artwork directory
1149     // (needed to prevent errors when trying to access unused artwork files)
1150     filename = getPath2(options.sounds_directory, SND_FALLBACK_FILENAME);
1151     if (fileExists(filename))
1152       return filename;
1153   }
1154
1155   return NULL;          // cannot find specified artwork file anywhere
1156 }
1157
1158 char *getCustomMusicFilename(char *basename)
1159 {
1160   static char *filename = NULL;
1161   boolean skip_setup_artwork = FALSE;
1162
1163   checked_free(filename);
1164
1165   basename = getCorrectedArtworkBasename(basename);
1166
1167   if (!gfx.override_level_music)
1168   {
1169     // 1st try: look for special artwork in current level series directory
1170     filename = getPath3(getCurrentLevelDir(), MUSIC_DIRECTORY, basename);
1171     if (fileExists(filename))
1172       return filename;
1173
1174     free(filename);
1175
1176     // check if there is special artwork configured in level series config
1177     if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL)
1178     {
1179       // 2nd try: look for special artwork configured in level series config
1180       filename = getPath2(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR), basename);
1181       if (fileExists(filename))
1182         return filename;
1183
1184       free(filename);
1185
1186       // take missing artwork configured in level set config from default
1187       skip_setup_artwork = TRUE;
1188     }
1189   }
1190
1191   if (!skip_setup_artwork)
1192   {
1193     // 3rd try: look for special artwork in configured artwork directory
1194     filename = getPath2(getSetupArtworkDir(artwork.mus_current), basename);
1195     if (fileExists(filename))
1196       return filename;
1197
1198     free(filename);
1199   }
1200
1201   // 4th try: look for default artwork in new default artwork directory
1202   filename = getPath2(getDefaultMusicDir(MUS_DEFAULT_SUBDIR), basename);
1203   if (fileExists(filename))
1204     return filename;
1205
1206   free(filename);
1207
1208   // 5th try: look for default artwork in old default artwork directory
1209   filename = getPath2(options.music_directory, basename);
1210   if (fileExists(filename))
1211     return filename;
1212
1213   if (!strEqual(MUS_FALLBACK_FILENAME, UNDEFINED_FILENAME))
1214   {
1215     free(filename);
1216
1217     WarnUsingFallback(basename);
1218
1219     // 6th try: look for fallback artwork in old default artwork directory
1220     // (needed to prevent errors when trying to access unused artwork files)
1221     filename = getPath2(options.music_directory, MUS_FALLBACK_FILENAME);
1222     if (fileExists(filename))
1223       return filename;
1224   }
1225
1226   return NULL;          // cannot find specified artwork file anywhere
1227 }
1228
1229 char *getCustomArtworkFilename(char *basename, int type)
1230 {
1231   if (type == ARTWORK_TYPE_GRAPHICS)
1232     return getCustomImageFilename(basename);
1233   else if (type == ARTWORK_TYPE_SOUNDS)
1234     return getCustomSoundFilename(basename);
1235   else if (type == ARTWORK_TYPE_MUSIC)
1236     return getCustomMusicFilename(basename);
1237   else
1238     return UNDEFINED_FILENAME;
1239 }
1240
1241 char *getCustomArtworkConfigFilename(int type)
1242 {
1243   return getCustomArtworkFilename(ARTWORKINFO_FILENAME(type), type);
1244 }
1245
1246 char *getCustomArtworkLevelConfigFilename(int type)
1247 {
1248   static char *filename = NULL;
1249
1250   checked_free(filename);
1251
1252   filename = getPath2(getLevelArtworkDir(type), ARTWORKINFO_FILENAME(type));
1253
1254   return filename;
1255 }
1256
1257 static boolean directoryExists_CheckMusic(char *directory, boolean check_music)
1258 {
1259   if (!directoryExists(directory))
1260     return FALSE;
1261
1262   if (!check_music)
1263     return TRUE;
1264
1265   Directory *dir;
1266   DirectoryEntry *dir_entry;
1267   int num_music = getMusicListSize();
1268   boolean music_found = FALSE;
1269
1270   if ((dir = openDirectory(directory)) == NULL)
1271     return FALSE;
1272
1273   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
1274   {
1275     char *basename = dir_entry->basename;
1276     boolean music_already_used = FALSE;
1277     int i;
1278
1279     // skip all music files that are configured in music config file
1280     for (i = 0; i < num_music; i++)
1281     {
1282       struct FileInfo *music = getMusicListEntry(i);
1283
1284       if (strEqual(basename, music->filename))
1285       {
1286         music_already_used = TRUE;
1287
1288         break;
1289       }
1290     }
1291
1292     if (music_already_used)
1293       continue;
1294
1295     if (FileIsMusic(dir_entry->filename))
1296     {
1297       music_found = TRUE;
1298
1299       break;
1300     }
1301   }
1302
1303   closeDirectory(dir);
1304
1305   return music_found;
1306 }
1307
1308 static char *getCustomMusicDirectoryExt(boolean check_music)
1309 {
1310   static char *directory = NULL;
1311   boolean skip_setup_artwork = FALSE;
1312
1313   checked_free(directory);
1314
1315   if (!gfx.override_level_music)
1316   {
1317     // 1st try: look for special artwork in current level series directory
1318     directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY);
1319     if (directoryExists_CheckMusic(directory, check_music))
1320       return directory;
1321
1322     free(directory);
1323
1324     // check if there is special artwork configured in level series config
1325     if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL)
1326     {
1327       // 2nd try: look for special artwork configured in level series config
1328       directory = getStringCopy(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR));
1329
1330       // directory also valid if no unconfigured music found (no game music)
1331       if (directoryExists_CheckMusic(directory, FALSE))
1332         return directory;
1333
1334       free(directory);
1335
1336       // take missing artwork configured in level set config from default
1337       skip_setup_artwork = TRUE;
1338     }
1339   }
1340
1341   if (!skip_setup_artwork)
1342   {
1343     // 3rd try: look for special artwork in configured artwork directory
1344     directory = getStringCopy(getSetupArtworkDir(artwork.mus_current));
1345
1346     // directory also valid if no unconfigured music found (no game music)
1347     if (directoryExists_CheckMusic(directory, FALSE))
1348       return directory;
1349
1350     free(directory);
1351   }
1352
1353   // 4th try: look for default artwork in new default artwork directory
1354   directory = getStringCopy(getDefaultMusicDir(MUS_DEFAULT_SUBDIR));
1355   if (directoryExists_CheckMusic(directory, check_music))
1356     return directory;
1357
1358   free(directory);
1359
1360   // 5th try: look for default artwork in old default artwork directory
1361   directory = getStringCopy(options.music_directory);
1362   if (directoryExists_CheckMusic(directory, check_music))
1363     return directory;
1364
1365   return NULL;          // cannot find specified artwork file anywhere
1366 }
1367
1368 char *getCustomMusicDirectory(void)
1369 {
1370   return getCustomMusicDirectoryExt(FALSE);
1371 }
1372
1373 char *getCustomMusicDirectory_NoConf(void)
1374 {
1375   return getCustomMusicDirectoryExt(TRUE);
1376 }
1377
1378 void MarkTapeDirectoryUploadsAsComplete(char *level_subdir)
1379 {
1380   char *filename = getPath2(getTapeDir(level_subdir), UPLOADED_FILENAME);
1381
1382   touchFile(filename);
1383
1384   checked_free(filename);
1385 }
1386
1387 void MarkTapeDirectoryUploadsAsIncomplete(char *level_subdir)
1388 {
1389   char *filename = getPath2(getTapeDir(level_subdir), UPLOADED_FILENAME);
1390
1391   unlink(filename);
1392
1393   checked_free(filename);
1394 }
1395
1396 boolean CheckTapeDirectoryUploadsComplete(char *level_subdir)
1397 {
1398   char *filename = getPath2(getTapeDir(level_subdir), UPLOADED_FILENAME);
1399   boolean success = fileExists(filename);
1400
1401   checked_free(filename);
1402
1403   return success;
1404 }
1405
1406 void InitMissingFileHash(void)
1407 {
1408   if (missing_file_hash == NULL)
1409     freeSetupFileHash(missing_file_hash);
1410
1411   missing_file_hash = newSetupFileHash();
1412 }
1413
1414 void InitTapeDirectory(char *level_subdir)
1415 {
1416   boolean new_tape_dir = !directoryExists(getTapeDir(level_subdir));
1417
1418   createDirectory(getUserGameDataDir(), "user data");
1419   createDirectory(getTapeDir(NULL), "main tape");
1420   createDirectory(getTapeDir(level_subdir), "level tape");
1421
1422   if (new_tape_dir)
1423     MarkTapeDirectoryUploadsAsComplete(level_subdir);
1424 }
1425
1426 void InitScoreDirectory(char *level_subdir)
1427 {
1428   createDirectory(getMainUserGameDataDir(), "main user data");
1429   createDirectory(getScoreDir(NULL), "main score");
1430   createDirectory(getScoreDir(level_subdir), "level score");
1431 }
1432
1433 void InitScoreCacheDirectory(char *level_subdir)
1434 {
1435   createDirectory(getMainUserGameDataDir(), "main user data");
1436   createDirectory(getCacheDir(), "cache data");
1437   createDirectory(getScoreCacheDir(NULL), "main score");
1438   createDirectory(getScoreCacheDir(level_subdir), "level score");
1439 }
1440
1441 void InitScoreTapeDirectory(char *level_subdir, int nr)
1442 {
1443   InitScoreDirectory(level_subdir);
1444
1445   createDirectory(getScoreTapeDir(level_subdir, nr), "score tape");
1446 }
1447
1448 void InitScoreCacheTapeDirectory(char *level_subdir, int nr)
1449 {
1450   InitScoreCacheDirectory(level_subdir);
1451
1452   createDirectory(getScoreCacheTapeDir(level_subdir, nr), "score tape");
1453 }
1454
1455 static void SaveUserLevelInfo(void);
1456
1457 void InitUserLevelDirectory(char *level_subdir)
1458 {
1459   if (!directoryExists(getUserLevelDir(level_subdir)))
1460   {
1461     createDirectory(getMainUserGameDataDir(), "main user data");
1462     createDirectory(getUserLevelDir(NULL), "main user level");
1463
1464     if (setup.internal.create_user_levelset)
1465     {
1466       createDirectory(getUserLevelDir(level_subdir), "user level");
1467
1468       SaveUserLevelInfo();
1469     }
1470   }
1471 }
1472
1473 void InitNetworkLevelDirectory(char *level_subdir)
1474 {
1475   if (!directoryExists(getNetworkLevelDir(level_subdir)))
1476   {
1477     createDirectory(getMainUserGameDataDir(), "main user data");
1478     createDirectory(getNetworkDir(), "network data");
1479     createDirectory(getNetworkLevelDir(NULL), "main network level");
1480     createDirectory(getNetworkLevelDir(level_subdir), "network level");
1481   }
1482 }
1483
1484 void InitLevelSetupDirectory(char *level_subdir)
1485 {
1486   createDirectory(getUserGameDataDir(), "user data");
1487   createDirectory(getLevelSetupDir(NULL), "main level setup");
1488   createDirectory(getLevelSetupDir(level_subdir), "level setup");
1489 }
1490
1491 static void InitCacheDirectory(void)
1492 {
1493   createDirectory(getMainUserGameDataDir(), "main user data");
1494   createDirectory(getCacheDir(), "cache data");
1495 }
1496
1497
1498 // ----------------------------------------------------------------------------
1499 // some functions to handle lists of level and artwork directories
1500 // ----------------------------------------------------------------------------
1501
1502 TreeInfo *newTreeInfo(void)
1503 {
1504   return checked_calloc(sizeof(TreeInfo));
1505 }
1506
1507 TreeInfo *newTreeInfo_setDefaults(int type)
1508 {
1509   TreeInfo *ti = newTreeInfo();
1510
1511   setTreeInfoToDefaults(ti, type);
1512
1513   return ti;
1514 }
1515
1516 void pushTreeInfo(TreeInfo **node_first, TreeInfo *node_new)
1517 {
1518   node_new->next = *node_first;
1519   *node_first = node_new;
1520 }
1521
1522 void removeTreeInfo(TreeInfo **node_first)
1523 {
1524   TreeInfo *node_old = *node_first;
1525
1526   *node_first = node_old->next;
1527   node_old->next = NULL;
1528
1529   freeTreeInfo(node_old);
1530 }
1531
1532 int numTreeInfo(TreeInfo *node)
1533 {
1534   int num = 0;
1535
1536   while (node)
1537   {
1538     num++;
1539     node = node->next;
1540   }
1541
1542   return num;
1543 }
1544
1545 boolean validLevelSeries(TreeInfo *node)
1546 {
1547   // in a number of cases, tree node is no valid level set
1548   if (node == NULL || node->node_group || node->parent_link || node->is_copy)
1549     return FALSE;
1550
1551   return TRUE;
1552 }
1553
1554 TreeInfo *getValidLevelSeries(TreeInfo *node, TreeInfo *default_node)
1555 {
1556   if (validLevelSeries(node))
1557     return node;
1558   else if (node->is_copy)
1559     return getTreeInfoFromIdentifier(leveldir_first, node->identifier);
1560   else
1561     return getFirstValidTreeInfoEntry(default_node);
1562 }
1563
1564 static TreeInfo *getValidTreeInfoEntryExt(TreeInfo *node, boolean get_next_node)
1565 {
1566   if (node == NULL)
1567     return NULL;
1568
1569   if (node->node_group)         // enter node group (step down into tree)
1570     return getFirstValidTreeInfoEntry(node->node_group);
1571
1572   if (node->parent_link)        // skip first node (back link) of node group
1573     get_next_node = TRUE;
1574
1575   if (!get_next_node)           // get current regular tree node
1576     return node;
1577
1578   // get next regular tree node, or step up until one is found
1579   while (node->next == NULL && node->node_parent != NULL)
1580     node = node->node_parent;
1581
1582   return getFirstValidTreeInfoEntry(node->next);
1583 }
1584
1585 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *node)
1586 {
1587   return getValidTreeInfoEntryExt(node, FALSE);
1588 }
1589
1590 TreeInfo *getNextValidTreeInfoEntry(TreeInfo *node)
1591 {
1592   return getValidTreeInfoEntryExt(node, TRUE);
1593 }
1594
1595 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *node)
1596 {
1597   if (node == NULL)
1598     return NULL;
1599
1600   if (node->node_parent == NULL)                // top level group
1601     return *node->node_top;
1602   else                                          // sub level group
1603     return node->node_parent->node_group;
1604 }
1605
1606 int numTreeInfoInGroup(TreeInfo *node)
1607 {
1608   return numTreeInfo(getTreeInfoFirstGroupEntry(node));
1609 }
1610
1611 int getPosFromTreeInfo(TreeInfo *node)
1612 {
1613   TreeInfo *node_cmp = getTreeInfoFirstGroupEntry(node);
1614   int pos = 0;
1615
1616   while (node_cmp)
1617   {
1618     if (node_cmp == node)
1619       return pos;
1620
1621     pos++;
1622     node_cmp = node_cmp->next;
1623   }
1624
1625   return 0;
1626 }
1627
1628 TreeInfo *getTreeInfoFromPos(TreeInfo *node, int pos)
1629 {
1630   TreeInfo *node_default = node;
1631   int pos_cmp = 0;
1632
1633   while (node)
1634   {
1635     if (pos_cmp == pos)
1636       return node;
1637
1638     pos_cmp++;
1639     node = node->next;
1640   }
1641
1642   return node_default;
1643 }
1644
1645 static TreeInfo *getTreeInfoFromIdentifierExt(TreeInfo *node, char *identifier,
1646                                               int node_type_wanted)
1647 {
1648   if (identifier == NULL)
1649     return NULL;
1650
1651   while (node)
1652   {
1653     if (TREE_NODE_TYPE(node) == node_type_wanted &&
1654         strEqual(identifier, node->identifier))
1655       return node;
1656
1657     if (node->node_group)
1658     {
1659       TreeInfo *node_group = getTreeInfoFromIdentifierExt(node->node_group,
1660                                                           identifier,
1661                                                           node_type_wanted);
1662       if (node_group)
1663         return node_group;
1664     }
1665
1666     node = node->next;
1667   }
1668
1669   return NULL;
1670 }
1671
1672 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier)
1673 {
1674   return getTreeInfoFromIdentifierExt(node, identifier, TREE_NODE_TYPE_DEFAULT);
1675 }
1676
1677 static TreeInfo *cloneTreeNode(TreeInfo **node_top, TreeInfo *node_parent,
1678                                TreeInfo *node, boolean skip_sets_without_levels)
1679 {
1680   TreeInfo *node_new;
1681
1682   if (node == NULL)
1683     return NULL;
1684
1685   if (!node->parent_link && !node->level_group &&
1686       skip_sets_without_levels && node->levels == 0)
1687     return cloneTreeNode(node_top, node_parent, node->next,
1688                          skip_sets_without_levels);
1689
1690   node_new = getTreeInfoCopy(node);             // copy complete node
1691
1692   node_new->node_top = node_top;                // correct top node link
1693   node_new->node_parent = node_parent;          // correct parent node link
1694
1695   if (node->level_group)
1696     node_new->node_group = cloneTreeNode(node_top, node_new, node->node_group,
1697                                          skip_sets_without_levels);
1698
1699   node_new->next = cloneTreeNode(node_top, node_parent, node->next,
1700                                  skip_sets_without_levels);
1701
1702   return node_new;
1703 }
1704
1705 static void cloneTree(TreeInfo **ti_new, TreeInfo *ti, boolean skip_empty_sets)
1706 {
1707   TreeInfo *ti_cloned = cloneTreeNode(ti_new, NULL, ti, skip_empty_sets);
1708
1709   *ti_new = ti_cloned;
1710 }
1711
1712 static boolean adjustTreeArtworkForEMC(char **artwork_set_1,
1713                                        char **artwork_set_2,
1714                                        char **artwork_set, boolean prefer_2)
1715 {
1716   // do nothing if neither special artwork set 1 nor 2 are defined
1717   if (!*artwork_set_1 && !*artwork_set_2)
1718     return FALSE;
1719
1720   boolean want_1 = (prefer_2 == FALSE);
1721   boolean want_2 = (prefer_2 == TRUE);
1722   boolean has_only_1 = (!*artwork_set && !*artwork_set_2);
1723   boolean has_only_2 = (!*artwork_set && !*artwork_set_1);
1724   char *artwork_set_new = NULL;
1725
1726   // replace missing special artwork 1 or 2 with (optional) standard artwork
1727
1728   if (!*artwork_set_1)
1729     setString(artwork_set_1, *artwork_set);
1730
1731   if (!*artwork_set_2)
1732     setString(artwork_set_2, *artwork_set);
1733
1734   // set standard artwork to either special artwork 1 or 2, as requested
1735
1736   if (*artwork_set_1 && (want_1 || has_only_1))
1737     artwork_set_new = *artwork_set_1;
1738
1739   if (*artwork_set_2 && (want_2 || has_only_2))
1740     artwork_set_new = *artwork_set_2;
1741
1742   if (artwork_set_new && !strEqual(*artwork_set, artwork_set_new))
1743   {
1744     setString(artwork_set, artwork_set_new);
1745
1746     return TRUE;
1747   }
1748
1749   return FALSE;
1750 }
1751
1752 static boolean adjustTreeGraphicsForEMC(TreeInfo *node)
1753 {
1754   boolean settings_changed = FALSE;
1755
1756   while (node)
1757   {
1758     settings_changed |= adjustTreeArtworkForEMC(&node->graphics_set_ecs,
1759                                                 &node->graphics_set_aga,
1760                                                 &node->graphics_set,
1761                                                 setup.prefer_aga_graphics);
1762     if (node->node_group != NULL)
1763       settings_changed |= adjustTreeGraphicsForEMC(node->node_group);
1764
1765     node = node->next;
1766   }
1767
1768   return settings_changed;
1769 }
1770
1771 static boolean adjustTreeSoundsForEMC(TreeInfo *node)
1772 {
1773   boolean settings_changed = FALSE;
1774
1775   while (node)
1776   {
1777     settings_changed |= adjustTreeArtworkForEMC(&node->sounds_set_default,
1778                                                 &node->sounds_set_lowpass,
1779                                                 &node->sounds_set,
1780                                                 setup.prefer_lowpass_sounds);
1781     if (node->node_group != NULL)
1782       settings_changed |= adjustTreeSoundsForEMC(node->node_group);
1783
1784     node = node->next;
1785   }
1786
1787   return settings_changed;
1788 }
1789
1790 int dumpTreeInfo(TreeInfo *node, int depth)
1791 {
1792   char bullet_list[] = { '-', '*', 'o' };
1793   int num_leaf_nodes = 0;
1794   int i;
1795
1796   if (depth == 0)
1797     Debug("tree", "Dumping TreeInfo:");
1798
1799   while (node)
1800   {
1801     char bullet = bullet_list[depth % ARRAY_SIZE(bullet_list)];
1802
1803     for (i = 0; i < depth * 2; i++)
1804       DebugContinued("", " ");
1805
1806     DebugContinued("tree", "%c '%s' ['%s] [PARENT: '%s'] %s\n",
1807                    bullet, node->name, node->identifier,
1808                    (node->node_parent ? node->node_parent->identifier : "-"),
1809                    (node->node_group ? "[GROUP]" :
1810                     node->is_copy ? "[COPY]" : ""));
1811
1812     if (!node->node_group && !node->parent_link)
1813       num_leaf_nodes++;
1814
1815     /*
1816     // use for dumping artwork info tree
1817     Debug("tree", "subdir == '%s' ['%s', '%s'] [%d])",
1818           node->subdir, node->fullpath, node->basepath, node->in_user_dir);
1819     */
1820
1821     if (node->node_group != NULL)
1822       num_leaf_nodes += dumpTreeInfo(node->node_group, depth + 1);
1823
1824     node = node->next;
1825   }
1826
1827   if (depth == 0)
1828     Debug("tree", "Summary: %d leaf nodes found", num_leaf_nodes);
1829
1830   return num_leaf_nodes;
1831 }
1832
1833 void sortTreeInfoBySortFunction(TreeInfo **node_first,
1834                                 int (*compare_function)(const void *,
1835                                                         const void *))
1836 {
1837   int num_nodes = numTreeInfo(*node_first);
1838   TreeInfo **sort_array;
1839   TreeInfo *node = *node_first;
1840   int i = 0;
1841
1842   if (num_nodes == 0)
1843     return;
1844
1845   // allocate array for sorting structure pointers
1846   sort_array = checked_calloc(num_nodes * sizeof(TreeInfo *));
1847
1848   // writing structure pointers to sorting array
1849   while (i < num_nodes && node)         // double boundary check...
1850   {
1851     sort_array[i] = node;
1852
1853     i++;
1854     node = node->next;
1855   }
1856
1857   // sorting the structure pointers in the sorting array
1858   qsort(sort_array, num_nodes, sizeof(TreeInfo *),
1859         compare_function);
1860
1861   // update the linkage of list elements with the sorted node array
1862   for (i = 0; i < num_nodes - 1; i++)
1863     sort_array[i]->next = sort_array[i + 1];
1864   sort_array[num_nodes - 1]->next = NULL;
1865
1866   // update the linkage of the main list anchor pointer
1867   *node_first = sort_array[0];
1868
1869   free(sort_array);
1870
1871   // now recursively sort the level group structures
1872   node = *node_first;
1873   while (node)
1874   {
1875     if (node->node_group != NULL)
1876       sortTreeInfoBySortFunction(&node->node_group, compare_function);
1877
1878     node = node->next;
1879   }
1880 }
1881
1882 void sortTreeInfo(TreeInfo **node_first)
1883 {
1884   sortTreeInfoBySortFunction(node_first, compareTreeInfoEntries);
1885 }
1886
1887
1888 // ============================================================================
1889 // some stuff from "files.c"
1890 // ============================================================================
1891
1892 #if defined(PLATFORM_WINDOWS)
1893 #ifndef S_IRGRP
1894 #define S_IRGRP S_IRUSR
1895 #endif
1896 #ifndef S_IROTH
1897 #define S_IROTH S_IRUSR
1898 #endif
1899 #ifndef S_IWGRP
1900 #define S_IWGRP S_IWUSR
1901 #endif
1902 #ifndef S_IWOTH
1903 #define S_IWOTH S_IWUSR
1904 #endif
1905 #ifndef S_IXGRP
1906 #define S_IXGRP S_IXUSR
1907 #endif
1908 #ifndef S_IXOTH
1909 #define S_IXOTH S_IXUSR
1910 #endif
1911 #ifndef S_IRWXG
1912 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
1913 #endif
1914 #ifndef S_ISGID
1915 #define S_ISGID 0
1916 #endif
1917 #endif  // PLATFORM_WINDOWS
1918
1919 // file permissions for newly written files
1920 #define MODE_R_ALL              (S_IRUSR | S_IRGRP | S_IROTH)
1921 #define MODE_W_ALL              (S_IWUSR | S_IWGRP | S_IWOTH)
1922 #define MODE_X_ALL              (S_IXUSR | S_IXGRP | S_IXOTH)
1923
1924 #define MODE_W_PRIVATE          (S_IWUSR)
1925 #define MODE_W_PUBLIC_FILE      (S_IWUSR | S_IWGRP)
1926 #define MODE_W_PUBLIC_DIR       (S_IWUSR | S_IWGRP | S_ISGID)
1927
1928 #define DIR_PERMS_PRIVATE       (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE)
1929 #define DIR_PERMS_PUBLIC        (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR)
1930 #define DIR_PERMS_PUBLIC_ALL    (MODE_R_ALL | MODE_X_ALL | MODE_W_ALL)
1931
1932 #define FILE_PERMS_PRIVATE      (MODE_R_ALL | MODE_W_PRIVATE)
1933 #define FILE_PERMS_PUBLIC       (MODE_R_ALL | MODE_W_PUBLIC_FILE)
1934 #define FILE_PERMS_PUBLIC_ALL   (MODE_R_ALL | MODE_W_ALL)
1935
1936
1937 char *getHomeDir(void)
1938 {
1939   static char *dir = NULL;
1940
1941 #if defined(PLATFORM_WINDOWS)
1942   if (dir == NULL)
1943   {
1944     dir = checked_malloc(MAX_PATH + 1);
1945
1946     if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
1947       strcpy(dir, ".");
1948   }
1949 #elif defined(PLATFORM_EMSCRIPTEN)
1950   dir = PERSISTENT_DIRECTORY;
1951 #elif defined(PLATFORM_UNIX)
1952   if (dir == NULL)
1953   {
1954     if ((dir = getenv("HOME")) == NULL)
1955     {
1956       dir = getUnixHomeDir();
1957
1958       if (dir != NULL)
1959         dir = getStringCopy(dir);
1960       else
1961         dir = ".";
1962     }
1963   }
1964 #else
1965   dir = ".";
1966 #endif
1967
1968   return dir;
1969 }
1970
1971 char *getPersonalDataDir(void)
1972 {
1973   static char *personal_data_dir = NULL;
1974
1975 #if defined(PLATFORM_MAC)
1976   if (personal_data_dir == NULL)
1977     personal_data_dir = getPath2(getHomeDir(), "Documents");
1978 #else
1979   if (personal_data_dir == NULL)
1980     personal_data_dir = getHomeDir();
1981 #endif
1982
1983   return personal_data_dir;
1984 }
1985
1986 char *getMainUserGameDataDir(void)
1987 {
1988   static char *main_user_data_dir = NULL;
1989
1990 #if defined(PLATFORM_ANDROID)
1991   if (main_user_data_dir == NULL)
1992     main_user_data_dir = (char *)(SDL_AndroidGetExternalStorageState() &
1993                                   SDL_ANDROID_EXTERNAL_STORAGE_WRITE ?
1994                                   SDL_AndroidGetExternalStoragePath() :
1995                                   SDL_AndroidGetInternalStoragePath());
1996 #else
1997   if (main_user_data_dir == NULL)
1998     main_user_data_dir = getPath2(getPersonalDataDir(),
1999                                   program.userdata_subdir);
2000 #endif
2001
2002   return main_user_data_dir;
2003 }
2004
2005 char *getUserGameDataDir(void)
2006 {
2007   if (user.nr == 0)
2008     return getMainUserGameDataDir();
2009   else
2010     return getUserDir(user.nr);
2011 }
2012
2013 char *getSetupDir(void)
2014 {
2015   return getUserGameDataDir();
2016 }
2017
2018 static mode_t posix_umask(mode_t mask)
2019 {
2020 #if defined(PLATFORM_UNIX)
2021   return umask(mask);
2022 #else
2023   return 0;
2024 #endif
2025 }
2026
2027 static int posix_mkdir(const char *pathname, mode_t mode)
2028 {
2029 #if defined(PLATFORM_WINDOWS)
2030   return mkdir(pathname);
2031 #else
2032   return mkdir(pathname, mode);
2033 #endif
2034 }
2035
2036 static boolean posix_process_running_setgid(void)
2037 {
2038 #if defined(PLATFORM_UNIX)
2039   return (getgid() != getegid());
2040 #else
2041   return FALSE;
2042 #endif
2043 }
2044
2045 void createDirectory(char *dir, char *text)
2046 {
2047   if (directoryExists(dir))
2048     return;
2049
2050   // leave "other" permissions in umask untouched, but ensure group parts
2051   // of USERDATA_DIR_MODE are not masked
2052   int permission_class = PERMS_PRIVATE;
2053   mode_t dir_mode = (permission_class == PERMS_PRIVATE ?
2054                      DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC);
2055   mode_t last_umask = posix_umask(0);
2056   mode_t group_umask = ~(dir_mode & S_IRWXG);
2057   int running_setgid = posix_process_running_setgid();
2058
2059   if (permission_class == PERMS_PUBLIC)
2060   {
2061     // if we're setgid, protect files against "other"
2062     // else keep umask(0) to make the dir world-writable
2063
2064     if (running_setgid)
2065       posix_umask(last_umask & group_umask);
2066     else
2067       dir_mode = DIR_PERMS_PUBLIC_ALL;
2068   }
2069
2070   if (posix_mkdir(dir, dir_mode) != 0)
2071     Warn("cannot create %s directory '%s': %s", text, dir, strerror(errno));
2072
2073   if (permission_class == PERMS_PUBLIC && !running_setgid)
2074     chmod(dir, dir_mode);
2075
2076   posix_umask(last_umask);              // restore previous umask
2077 }
2078
2079 void InitMainUserDataDirectory(void)
2080 {
2081   createDirectory(getMainUserGameDataDir(), "main user data");
2082 }
2083
2084 void InitUserDataDirectory(void)
2085 {
2086   createDirectory(getMainUserGameDataDir(), "main user data");
2087
2088   if (user.nr != 0)
2089   {
2090     createDirectory(getUserDir(-1), "users");
2091     createDirectory(getUserDir(user.nr), "user data");
2092   }
2093 }
2094
2095 void SetFilePermissions(char *filename, int permission_class)
2096 {
2097   int running_setgid = posix_process_running_setgid();
2098   int perms = (permission_class == PERMS_PRIVATE ?
2099                FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC);
2100
2101   if (permission_class == PERMS_PUBLIC && !running_setgid)
2102     perms = FILE_PERMS_PUBLIC_ALL;
2103
2104   chmod(filename, perms);
2105 }
2106
2107 void fprintFileHeader(FILE *file, char *basename)
2108 {
2109   char *prefix = "# ";
2110   char *sep1 = "=";
2111
2112   fprintf_line_with_prefix(file, prefix, sep1, 77);
2113   fprintf(file, "%s%s\n", prefix, basename);
2114   fprintf_line_with_prefix(file, prefix, sep1, 77);
2115   fprintf(file, "\n");
2116 }
2117
2118 int getFileVersionFromCookieString(const char *cookie)
2119 {
2120   const char *ptr_cookie1, *ptr_cookie2;
2121   const char *pattern1 = "_FILE_VERSION_";
2122   const char *pattern2 = "?.?";
2123   const int len_cookie = strlen(cookie);
2124   const int len_pattern1 = strlen(pattern1);
2125   const int len_pattern2 = strlen(pattern2);
2126   const int len_pattern = len_pattern1 + len_pattern2;
2127   int version_super, version_major;
2128
2129   if (len_cookie <= len_pattern)
2130     return -1;
2131
2132   ptr_cookie1 = &cookie[len_cookie - len_pattern];
2133   ptr_cookie2 = &cookie[len_cookie - len_pattern2];
2134
2135   if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0)
2136     return -1;
2137
2138   if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' ||
2139       ptr_cookie2[1] != '.' ||
2140       ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9')
2141     return -1;
2142
2143   version_super = ptr_cookie2[0] - '0';
2144   version_major = ptr_cookie2[2] - '0';
2145
2146   return VERSION_IDENT(version_super, version_major, 0, 0);
2147 }
2148
2149 boolean checkCookieString(const char *cookie, const char *template)
2150 {
2151   const char *pattern = "_FILE_VERSION_?.?";
2152   const int len_cookie = strlen(cookie);
2153   const int len_template = strlen(template);
2154   const int len_pattern = strlen(pattern);
2155
2156   if (len_cookie != len_template)
2157     return FALSE;
2158
2159   if (strncmp(cookie, template, len_cookie - len_pattern) != 0)
2160     return FALSE;
2161
2162   return TRUE;
2163 }
2164
2165
2166 // ----------------------------------------------------------------------------
2167 // setup file list and hash handling functions
2168 // ----------------------------------------------------------------------------
2169
2170 char *getFormattedSetupEntry(char *token, char *value)
2171 {
2172   int i;
2173   static char entry[MAX_LINE_LEN];
2174
2175   // if value is an empty string, just return token without value
2176   if (*value == '\0')
2177     return token;
2178
2179   // start with the token and some spaces to format output line
2180   sprintf(entry, "%s:", token);
2181   for (i = strlen(entry); i < token_value_position; i++)
2182     strcat(entry, " ");
2183
2184   // continue with the token's value
2185   strcat(entry, value);
2186
2187   return entry;
2188 }
2189
2190 SetupFileList *newSetupFileList(char *token, char *value)
2191 {
2192   SetupFileList *new = checked_malloc(sizeof(SetupFileList));
2193
2194   new->token = getStringCopy(token);
2195   new->value = getStringCopy(value);
2196
2197   new->next = NULL;
2198
2199   return new;
2200 }
2201
2202 void freeSetupFileList(SetupFileList *list)
2203 {
2204   if (list == NULL)
2205     return;
2206
2207   checked_free(list->token);
2208   checked_free(list->value);
2209
2210   if (list->next)
2211     freeSetupFileList(list->next);
2212
2213   free(list);
2214 }
2215
2216 char *getListEntry(SetupFileList *list, char *token)
2217 {
2218   if (list == NULL)
2219     return NULL;
2220
2221   if (strEqual(list->token, token))
2222     return list->value;
2223   else
2224     return getListEntry(list->next, token);
2225 }
2226
2227 SetupFileList *setListEntry(SetupFileList *list, char *token, char *value)
2228 {
2229   if (list == NULL)
2230     return NULL;
2231
2232   if (strEqual(list->token, token))
2233   {
2234     checked_free(list->value);
2235
2236     list->value = getStringCopy(value);
2237
2238     return list;
2239   }
2240   else if (list->next == NULL)
2241     return (list->next = newSetupFileList(token, value));
2242   else
2243     return setListEntry(list->next, token, value);
2244 }
2245
2246 SetupFileList *addListEntry(SetupFileList *list, char *token, char *value)
2247 {
2248   if (list == NULL)
2249     return NULL;
2250
2251   if (list->next == NULL)
2252     return (list->next = newSetupFileList(token, value));
2253   else
2254     return addListEntry(list->next, token, value);
2255 }
2256
2257 #if ENABLE_UNUSED_CODE
2258 #ifdef DEBUG
2259 static void printSetupFileList(SetupFileList *list)
2260 {
2261   if (!list)
2262     return;
2263
2264   Debug("setup:printSetupFileList", "token: '%s'", list->token);
2265   Debug("setup:printSetupFileList", "value: '%s'", list->value);
2266
2267   printSetupFileList(list->next);
2268 }
2269 #endif
2270 #endif
2271
2272 #ifdef DEBUG
2273 DEFINE_HASHTABLE_INSERT(insert_hash_entry, char, char);
2274 DEFINE_HASHTABLE_SEARCH(search_hash_entry, char, char);
2275 DEFINE_HASHTABLE_CHANGE(change_hash_entry, char, char);
2276 DEFINE_HASHTABLE_REMOVE(remove_hash_entry, char, char);
2277 #else
2278 #define insert_hash_entry hashtable_insert
2279 #define search_hash_entry hashtable_search
2280 #define change_hash_entry hashtable_change
2281 #define remove_hash_entry hashtable_remove
2282 #endif
2283
2284 unsigned int get_hash_from_string(void *key)
2285 {
2286   /*
2287     djb2
2288
2289     This algorithm (k=33) was first reported by Dan Bernstein many years ago in
2290     'comp.lang.c'. Another version of this algorithm (now favored by Bernstein)
2291     uses XOR: hash(i) = hash(i - 1) * 33 ^ str[i]; the magic of number 33 (why
2292     it works better than many other constants, prime or not) has never been
2293     adequately explained.
2294
2295     If you just want to have a good hash function, and cannot wait, djb2
2296     is one of the best string hash functions i know. It has excellent
2297     distribution and speed on many different sets of keys and table sizes.
2298     You are not likely to do better with one of the "well known" functions
2299     such as PJW, K&R, etc.
2300
2301     Ozan (oz) Yigit [http://www.cs.yorku.ca/~oz/hash.html]
2302   */
2303
2304   char *str = (char *)key;
2305   unsigned int hash = 5381;
2306   int c;
2307
2308   while ((c = *str++))
2309     hash = ((hash << 5) + hash) + c;    // hash * 33 + c
2310
2311   return hash;
2312 }
2313
2314 unsigned int get_hash_from_integer(void *key)
2315 {
2316   unsigned int hash = PTR_TO_UINT(key);
2317
2318   return hash;
2319 }
2320
2321 int hash_key_strings_are_equal(void *key1, void *key2)
2322 {
2323   return (strEqual((char *)key1, (char *)key2));
2324 }
2325
2326 int hash_key_integers_are_equal(void *key1, void *key2)
2327 {
2328   return (key1 == key2);
2329 }
2330
2331 SetupFileHash *newSetupFileHash(void)
2332 {
2333   SetupFileHash *new_hash =
2334     create_hashtable(get_hash_from_string, hash_key_strings_are_equal, free, free);
2335
2336   if (new_hash == NULL)
2337     Fail("create_hashtable() failed -- out of memory");
2338
2339   return new_hash;
2340 }
2341
2342 void freeSetupFileHash(SetupFileHash *hash)
2343 {
2344   if (hash == NULL)
2345     return;
2346
2347   hashtable_destroy(hash);
2348 }
2349
2350 char *getHashEntry(SetupFileHash *hash, char *token)
2351 {
2352   if (hash == NULL)
2353     return NULL;
2354
2355   return search_hash_entry(hash, token);
2356 }
2357
2358 void setHashEntry(SetupFileHash *hash, char *token, char *value)
2359 {
2360   char *value_copy;
2361
2362   if (hash == NULL)
2363     return;
2364
2365   value_copy = getStringCopy(value);
2366
2367   // change value; if it does not exist, insert it as new
2368   if (!change_hash_entry(hash, token, value_copy))
2369     if (!insert_hash_entry(hash, getStringCopy(token), value_copy))
2370       Fail("cannot insert into hash -- aborting");
2371 }
2372
2373 void removeHashEntry(SetupFileHash *hash, char *token)
2374 {
2375   if (hash == NULL)
2376     return;
2377
2378   remove_hash_entry(hash, token);
2379 }
2380
2381 #if ENABLE_UNUSED_CODE
2382 #if DEBUG
2383 static void printSetupFileHash(SetupFileHash *hash)
2384 {
2385   BEGIN_HASH_ITERATION(hash, itr)
2386   {
2387     Debug("setup:printSetupFileHash", "token: '%s'", HASH_ITERATION_TOKEN(itr));
2388     Debug("setup:printSetupFileHash", "value: '%s'", HASH_ITERATION_VALUE(itr));
2389   }
2390   END_HASH_ITERATION(hash, itr)
2391 }
2392 #endif
2393 #endif
2394
2395 #define ALLOW_TOKEN_VALUE_SEPARATOR_BEING_WHITESPACE            1
2396 #define CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING            0
2397 #define CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH             0
2398
2399 static boolean token_value_separator_found = FALSE;
2400 #if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING
2401 static boolean token_value_separator_warning = FALSE;
2402 #endif
2403 #if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH
2404 static boolean token_already_exists_warning = FALSE;
2405 #endif
2406
2407 static boolean getTokenValueFromSetupLineExt(char *line,
2408                                              char **token_ptr, char **value_ptr,
2409                                              char *filename, char *line_raw,
2410                                              int line_nr,
2411                                              boolean separator_required)
2412 {
2413   static char line_copy[MAX_LINE_LEN + 1], line_raw_copy[MAX_LINE_LEN + 1];
2414   char *token, *value, *line_ptr;
2415
2416   // when externally invoked via ReadTokenValueFromLine(), copy line buffers
2417   if (line_raw == NULL)
2418   {
2419     strncpy(line_copy, line, MAX_LINE_LEN);
2420     line_copy[MAX_LINE_LEN] = '\0';
2421     line = line_copy;
2422
2423     strcpy(line_raw_copy, line_copy);
2424     line_raw = line_raw_copy;
2425   }
2426
2427   // cut trailing comment from input line
2428   for (line_ptr = line; *line_ptr; line_ptr++)
2429   {
2430     if (*line_ptr == '#')
2431     {
2432       *line_ptr = '\0';
2433       break;
2434     }
2435   }
2436
2437   // cut trailing whitespaces from input line
2438   for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
2439     if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0')
2440       *line_ptr = '\0';
2441
2442   // ignore empty lines
2443   if (*line == '\0')
2444     return FALSE;
2445
2446   // cut leading whitespaces from token
2447   for (token = line; *token; token++)
2448     if (*token != ' ' && *token != '\t')
2449       break;
2450
2451   // start with empty value as reliable default
2452   value = "";
2453
2454   token_value_separator_found = FALSE;
2455
2456   // find end of token to determine start of value
2457   for (line_ptr = token; *line_ptr; line_ptr++)
2458   {
2459     // first look for an explicit token/value separator, like ':' or '='
2460     if (*line_ptr == ':' || *line_ptr == '=')
2461     {
2462       *line_ptr = '\0';                 // terminate token string
2463       value = line_ptr + 1;             // set beginning of value
2464
2465       token_value_separator_found = TRUE;
2466
2467       break;
2468     }
2469   }
2470
2471 #if ALLOW_TOKEN_VALUE_SEPARATOR_BEING_WHITESPACE
2472   // fallback: if no token/value separator found, also allow whitespaces
2473   if (!token_value_separator_found && !separator_required)
2474   {
2475     for (line_ptr = token; *line_ptr; line_ptr++)
2476     {
2477       if (*line_ptr == ' ' || *line_ptr == '\t')
2478       {
2479         *line_ptr = '\0';               // terminate token string
2480         value = line_ptr + 1;           // set beginning of value
2481
2482         token_value_separator_found = TRUE;
2483
2484         break;
2485       }
2486     }
2487
2488 #if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING
2489     if (token_value_separator_found)
2490     {
2491       if (!token_value_separator_warning)
2492       {
2493         Debug("setup", "---");
2494
2495         if (filename != NULL)
2496         {
2497           Debug("setup", "missing token/value separator(s) in config file:");
2498           Debug("setup", "- config file: '%s'", filename);
2499         }
2500         else
2501         {
2502           Debug("setup", "missing token/value separator(s):");
2503         }
2504
2505         token_value_separator_warning = TRUE;
2506       }
2507
2508       if (filename != NULL)
2509         Debug("setup", "- line %d: '%s'", line_nr, line_raw);
2510       else
2511         Debug("setup", "- line: '%s'", line_raw);
2512     }
2513 #endif
2514   }
2515 #endif
2516
2517   // cut trailing whitespaces from token
2518   for (line_ptr = &token[strlen(token)]; line_ptr >= token; line_ptr--)
2519     if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0')
2520       *line_ptr = '\0';
2521
2522   // cut leading whitespaces from value
2523   for (; *value; value++)
2524     if (*value != ' ' && *value != '\t')
2525       break;
2526
2527   *token_ptr = token;
2528   *value_ptr = value;
2529
2530   return TRUE;
2531 }
2532
2533 boolean getTokenValueFromSetupLine(char *line, char **token, char **value)
2534 {
2535   // while the internal (old) interface does not require a token/value
2536   // separator (for downwards compatibility with existing files which
2537   // don't use them), it is mandatory for the external (new) interface
2538
2539   return getTokenValueFromSetupLineExt(line, token, value, NULL, NULL, 0, TRUE);
2540 }
2541
2542 static boolean loadSetupFileData(void *setup_file_data, char *filename,
2543                                  boolean top_recursion_level, boolean is_hash)
2544 {
2545   static SetupFileHash *include_filename_hash = NULL;
2546   char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN];
2547   char *token, *value, *line_ptr;
2548   void *insert_ptr = NULL;
2549   boolean read_continued_line = FALSE;
2550   File *file;
2551   int line_nr = 0, token_count = 0, include_count = 0;
2552
2553 #if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING
2554   token_value_separator_warning = FALSE;
2555 #endif
2556
2557 #if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH
2558   token_already_exists_warning = FALSE;
2559 #endif
2560
2561   if (!(file = openFile(filename, MODE_READ)))
2562   {
2563 #if DEBUG_NO_CONFIG_FILE
2564     Debug("setup", "cannot open configuration file '%s'", filename);
2565 #endif
2566
2567     return FALSE;
2568   }
2569
2570   // use "insert pointer" to store list end for constant insertion complexity
2571   if (!is_hash)
2572     insert_ptr = setup_file_data;
2573
2574   // on top invocation, create hash to mark included files (to prevent loops)
2575   if (top_recursion_level)
2576     include_filename_hash = newSetupFileHash();
2577
2578   // mark this file as already included (to prevent including it again)
2579   setHashEntry(include_filename_hash, getBaseNamePtr(filename), "true");
2580
2581   while (!checkEndOfFile(file))
2582   {
2583     // read next line of input file
2584     if (!getStringFromFile(file, line, MAX_LINE_LEN))
2585       break;
2586
2587     // check if line was completely read and is terminated by line break
2588     if (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
2589       line_nr++;
2590
2591     // cut trailing line break (this can be newline and/or carriage return)
2592     for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--)
2593       if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
2594         *line_ptr = '\0';
2595
2596     // copy raw input line for later use (mainly debugging output)
2597     strcpy(line_raw, line);
2598
2599     if (read_continued_line)
2600     {
2601       // append new line to existing line, if there is enough space
2602       if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN)
2603         strcat(previous_line, line_ptr);
2604
2605       strcpy(line, previous_line);      // copy storage buffer to line
2606
2607       read_continued_line = FALSE;
2608     }
2609
2610     // if the last character is '\', continue at next line
2611     if (strlen(line) > 0 && line[strlen(line) - 1] == '\\')
2612     {
2613       line[strlen(line) - 1] = '\0';    // cut off trailing backslash
2614       strcpy(previous_line, line);      // copy line to storage buffer
2615
2616       read_continued_line = TRUE;
2617
2618       continue;
2619     }
2620
2621     if (!getTokenValueFromSetupLineExt(line, &token, &value, filename,
2622                                        line_raw, line_nr, FALSE))
2623       continue;
2624
2625     if (*token)
2626     {
2627       if (strEqual(token, "include"))
2628       {
2629         if (getHashEntry(include_filename_hash, value) == NULL)
2630         {
2631           char *basepath = getBasePath(filename);
2632           char *basename = getBaseName(value);
2633           char *filename_include = getPath2(basepath, basename);
2634
2635           loadSetupFileData(setup_file_data, filename_include, FALSE, is_hash);
2636
2637           free(basepath);
2638           free(basename);
2639           free(filename_include);
2640
2641           include_count++;
2642         }
2643         else
2644         {
2645           Warn("ignoring already processed file '%s'", value);
2646         }
2647       }
2648       else
2649       {
2650         if (is_hash)
2651         {
2652 #if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH
2653           char *old_value =
2654             getHashEntry((SetupFileHash *)setup_file_data, token);
2655
2656           if (old_value != NULL)
2657           {
2658             if (!token_already_exists_warning)
2659             {
2660               Debug("setup", "---");
2661               Debug("setup", "duplicate token(s) found in config file:");
2662               Debug("setup", "- config file: '%s'", filename);
2663
2664               token_already_exists_warning = TRUE;
2665             }
2666
2667             Debug("setup", "- token: '%s' (in line %d)", token, line_nr);
2668             Debug("setup", "  old value: '%s'", old_value);
2669             Debug("setup", "  new value: '%s'", value);
2670           }
2671 #endif
2672
2673           setHashEntry((SetupFileHash *)setup_file_data, token, value);
2674         }
2675         else
2676         {
2677           insert_ptr = addListEntry((SetupFileList *)insert_ptr, token, value);
2678         }
2679
2680         token_count++;
2681       }
2682     }
2683   }
2684
2685   closeFile(file);
2686
2687 #if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING
2688   if (token_value_separator_warning)
2689     Debug("setup", "---");
2690 #endif
2691
2692 #if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH
2693   if (token_already_exists_warning)
2694     Debug("setup", "---");
2695 #endif
2696
2697   if (token_count == 0 && include_count == 0)
2698     Warn("configuration file '%s' is empty", filename);
2699
2700   if (top_recursion_level)
2701     freeSetupFileHash(include_filename_hash);
2702
2703   return TRUE;
2704 }
2705
2706 static int compareSetupFileData(const void *object1, const void *object2)
2707 {
2708   const struct ConfigInfo *entry1 = (struct ConfigInfo *)object1;
2709   const struct ConfigInfo *entry2 = (struct ConfigInfo *)object2;
2710
2711   return strcmp(entry1->token, entry2->token);
2712 }
2713
2714 static void saveSetupFileHash(SetupFileHash *hash, char *filename)
2715 {
2716   int item_count = hashtable_count(hash);
2717   int item_size = sizeof(struct ConfigInfo);
2718   struct ConfigInfo *sort_array = checked_malloc(item_count * item_size);
2719   FILE *file;
2720   int i = 0;
2721
2722   // copy string pointers from hash to array
2723   BEGIN_HASH_ITERATION(hash, itr)
2724   {
2725     sort_array[i].token = HASH_ITERATION_TOKEN(itr);
2726     sort_array[i].value = HASH_ITERATION_VALUE(itr);
2727
2728     i++;
2729
2730     if (i > item_count)         // should never happen
2731       break;
2732   }
2733   END_HASH_ITERATION(hash, itr)
2734
2735   // sort string pointers from hash in array
2736   qsort(sort_array, item_count, item_size, compareSetupFileData);
2737
2738   if (!(file = fopen(filename, MODE_WRITE)))
2739   {
2740     Warn("cannot write configuration file '%s'", filename);
2741
2742     return;
2743   }
2744
2745   fprintf(file, "%s\n\n", getFormattedSetupEntry("program.version",
2746                                                  program.version_string));
2747   for (i = 0; i < item_count; i++)
2748     fprintf(file, "%s\n", getFormattedSetupEntry(sort_array[i].token,
2749                                                  sort_array[i].value));
2750   fclose(file);
2751
2752   checked_free(sort_array);
2753 }
2754
2755 SetupFileList *loadSetupFileList(char *filename)
2756 {
2757   SetupFileList *setup_file_list = newSetupFileList("", "");
2758   SetupFileList *first_valid_list_entry;
2759
2760   if (!loadSetupFileData(setup_file_list, filename, TRUE, FALSE))
2761   {
2762     freeSetupFileList(setup_file_list);
2763
2764     return NULL;
2765   }
2766
2767   first_valid_list_entry = setup_file_list->next;
2768
2769   // free empty list header
2770   setup_file_list->next = NULL;
2771   freeSetupFileList(setup_file_list);
2772
2773   return first_valid_list_entry;
2774 }
2775
2776 SetupFileHash *loadSetupFileHash(char *filename)
2777 {
2778   SetupFileHash *setup_file_hash = newSetupFileHash();
2779
2780   if (!loadSetupFileData(setup_file_hash, filename, TRUE, TRUE))
2781   {
2782     freeSetupFileHash(setup_file_hash);
2783
2784     return NULL;
2785   }
2786
2787   return setup_file_hash;
2788 }
2789
2790
2791 // ============================================================================
2792 // setup file stuff
2793 // ============================================================================
2794
2795 #define TOKEN_STR_LAST_LEVEL_SERIES             "last_level_series"
2796 #define TOKEN_STR_LAST_PLAYED_MENU_USED         "last_played_menu_used"
2797 #define TOKEN_STR_LAST_PLAYED_LEVEL             "last_played_level"
2798 #define TOKEN_STR_HANDICAP_LEVEL                "handicap_level"
2799 #define TOKEN_STR_LAST_USER                     "last_user"
2800
2801 // level directory info
2802 #define LEVELINFO_TOKEN_IDENTIFIER              0
2803 #define LEVELINFO_TOKEN_NAME                    1
2804 #define LEVELINFO_TOKEN_NAME_SORTING            2
2805 #define LEVELINFO_TOKEN_AUTHOR                  3
2806 #define LEVELINFO_TOKEN_YEAR                    4
2807 #define LEVELINFO_TOKEN_PROGRAM_TITLE           5
2808 #define LEVELINFO_TOKEN_PROGRAM_COPYRIGHT       6
2809 #define LEVELINFO_TOKEN_PROGRAM_COMPANY         7
2810 #define LEVELINFO_TOKEN_IMPORTED_FROM           8
2811 #define LEVELINFO_TOKEN_IMPORTED_BY             9
2812 #define LEVELINFO_TOKEN_TESTED_BY               10
2813 #define LEVELINFO_TOKEN_LEVELS                  11
2814 #define LEVELINFO_TOKEN_FIRST_LEVEL             12
2815 #define LEVELINFO_TOKEN_SORT_PRIORITY           13
2816 #define LEVELINFO_TOKEN_LATEST_ENGINE           14
2817 #define LEVELINFO_TOKEN_LEVEL_GROUP             15
2818 #define LEVELINFO_TOKEN_READONLY                16
2819 #define LEVELINFO_TOKEN_GRAPHICS_SET_ECS        17
2820 #define LEVELINFO_TOKEN_GRAPHICS_SET_AGA        18
2821 #define LEVELINFO_TOKEN_GRAPHICS_SET            19
2822 #define LEVELINFO_TOKEN_SOUNDS_SET_DEFAULT      20
2823 #define LEVELINFO_TOKEN_SOUNDS_SET_LOWPASS      21
2824 #define LEVELINFO_TOKEN_SOUNDS_SET              22
2825 #define LEVELINFO_TOKEN_MUSIC_SET               23
2826 #define LEVELINFO_TOKEN_FILENAME                24
2827 #define LEVELINFO_TOKEN_FILETYPE                25
2828 #define LEVELINFO_TOKEN_SPECIAL_FLAGS           26
2829 #define LEVELINFO_TOKEN_EMPTY_LEVEL_NAME        27
2830 #define LEVELINFO_TOKEN_FORCE_LEVEL_NAME        28
2831 #define LEVELINFO_TOKEN_HANDICAP                29
2832 #define LEVELINFO_TOKEN_TIME_LIMIT              30
2833 #define LEVELINFO_TOKEN_SKIP_LEVELS             31
2834 #define LEVELINFO_TOKEN_USE_EMC_TILES           32
2835 #define LEVELINFO_TOKEN_INFO_SCREENS_FROM_MAIN  33
2836
2837 #define NUM_LEVELINFO_TOKENS                    34
2838
2839 static LevelDirTree ldi;
2840
2841 static struct TokenInfo levelinfo_tokens[] =
2842 {
2843   // level directory info
2844   { TYPE_STRING,        &ldi.identifier,        "identifier"            },
2845   { TYPE_STRING,        &ldi.name,              "name"                  },
2846   { TYPE_STRING,        &ldi.name_sorting,      "name_sorting"          },
2847   { TYPE_STRING,        &ldi.author,            "author"                },
2848   { TYPE_STRING,        &ldi.year,              "year"                  },
2849   { TYPE_STRING,        &ldi.program_title,     "program_title"         },
2850   { TYPE_STRING,        &ldi.program_copyright, "program_copyright"     },
2851   { TYPE_STRING,        &ldi.program_company,   "program_company"       },
2852   { TYPE_STRING,        &ldi.imported_from,     "imported_from"         },
2853   { TYPE_STRING,        &ldi.imported_by,       "imported_by"           },
2854   { TYPE_STRING,        &ldi.tested_by,         "tested_by"             },
2855   { TYPE_INTEGER,       &ldi.levels,            "levels"                },
2856   { TYPE_INTEGER,       &ldi.first_level,       "first_level"           },
2857   { TYPE_INTEGER,       &ldi.sort_priority,     "sort_priority"         },
2858   { TYPE_BOOLEAN,       &ldi.latest_engine,     "latest_engine"         },
2859   { TYPE_BOOLEAN,       &ldi.level_group,       "level_group"           },
2860   { TYPE_BOOLEAN,       &ldi.readonly,          "readonly"              },
2861   { TYPE_STRING,        &ldi.graphics_set_ecs,  "graphics_set.old"      },
2862   { TYPE_STRING,        &ldi.graphics_set_aga,  "graphics_set.new"      },
2863   { TYPE_STRING,        &ldi.graphics_set_ecs,  "graphics_set.ecs"      },
2864   { TYPE_STRING,        &ldi.graphics_set_aga,  "graphics_set.aga"      },
2865   { TYPE_STRING,        &ldi.graphics_set,      "graphics_set"          },
2866   { TYPE_STRING,        &ldi.sounds_set_default,"sounds_set.default"    },
2867   { TYPE_STRING,        &ldi.sounds_set_lowpass,"sounds_set.lowpass"    },
2868   { TYPE_STRING,        &ldi.sounds_set,        "sounds_set"            },
2869   { TYPE_STRING,        &ldi.music_set,         "music_set"             },
2870   { TYPE_STRING,        &ldi.level_filename,    "filename"              },
2871   { TYPE_STRING,        &ldi.level_filetype,    "filetype"              },
2872   { TYPE_STRING,        &ldi.special_flags,     "special_flags"         },
2873   { TYPE_STRING,        &ldi.empty_level_name,  "empty_level_name"      },
2874   { TYPE_BOOLEAN,       &ldi.force_level_name,  "force_level_name"      },
2875   { TYPE_BOOLEAN,       &ldi.handicap,          "handicap"              },
2876   { TYPE_BOOLEAN,       &ldi.time_limit,        "time_limit"            },
2877   { TYPE_BOOLEAN,       &ldi.skip_levels,       "skip_levels"           },
2878   { TYPE_BOOLEAN,       &ldi.use_emc_tiles,     "use_emc_tiles"         },
2879   { TYPE_BOOLEAN,       &ldi.info_screens_from_main, "info_screens_from_main" }
2880 };
2881
2882 static struct TokenInfo artworkinfo_tokens[] =
2883 {
2884   // artwork directory info
2885   { TYPE_STRING,        &ldi.identifier,        "identifier"            },
2886   { TYPE_STRING,        &ldi.subdir,            "subdir"                },
2887   { TYPE_STRING,        &ldi.name,              "name"                  },
2888   { TYPE_STRING,        &ldi.name_sorting,      "name_sorting"          },
2889   { TYPE_STRING,        &ldi.author,            "author"                },
2890   { TYPE_STRING,        &ldi.program_title,     "program_title"         },
2891   { TYPE_STRING,        &ldi.program_copyright, "program_copyright"     },
2892   { TYPE_STRING,        &ldi.program_company,   "program_company"       },
2893   { TYPE_INTEGER,       &ldi.sort_priority,     "sort_priority"         },
2894   { TYPE_STRING,        &ldi.basepath,          "basepath"              },
2895   { TYPE_STRING,        &ldi.fullpath,          "fullpath"              },
2896   { TYPE_BOOLEAN,       &ldi.in_user_dir,       "in_user_dir"           },
2897   { TYPE_STRING,        &ldi.class_desc,        "class_desc"            },
2898
2899   { -1,                 NULL,                   NULL                    },
2900 };
2901
2902 static char *optional_tokens[] =
2903 {
2904   "program_title",
2905   "program_copyright",
2906   "program_company",
2907
2908   NULL
2909 };
2910
2911 static void setTreeInfoToDefaults(TreeInfo *ti, int type)
2912 {
2913   ti->type = type;
2914
2915   ti->node_top = (ti->type == TREE_TYPE_LEVEL_DIR    ? &leveldir_first :
2916                   ti->type == TREE_TYPE_GRAPHICS_DIR ? &artwork.gfx_first :
2917                   ti->type == TREE_TYPE_SOUNDS_DIR   ? &artwork.snd_first :
2918                   ti->type == TREE_TYPE_MUSIC_DIR    ? &artwork.mus_first :
2919                   NULL);
2920
2921   ti->node_parent = NULL;
2922   ti->node_group = NULL;
2923   ti->next = NULL;
2924
2925   ti->cl_first = -1;
2926   ti->cl_cursor = -1;
2927
2928   ti->subdir = NULL;
2929   ti->fullpath = NULL;
2930   ti->basepath = NULL;
2931   ti->identifier = NULL;
2932   ti->name = getStringCopy(ANONYMOUS_NAME);
2933   ti->name_sorting = NULL;
2934   ti->author = getStringCopy(ANONYMOUS_NAME);
2935   ti->year = NULL;
2936
2937   ti->program_title = NULL;
2938   ti->program_copyright = NULL;
2939   ti->program_company = NULL;
2940
2941   ti->sort_priority = LEVELCLASS_UNDEFINED;     // default: least priority
2942   ti->latest_engine = FALSE;                    // default: get from level
2943   ti->parent_link = FALSE;
2944   ti->is_copy = FALSE;
2945   ti->in_user_dir = FALSE;
2946   ti->user_defined = FALSE;
2947   ti->color = 0;
2948   ti->class_desc = NULL;
2949
2950   ti->infotext = getStringCopy(TREE_INFOTEXT(ti->type));
2951
2952   if (ti->type == TREE_TYPE_LEVEL_DIR)
2953   {
2954     ti->imported_from = NULL;
2955     ti->imported_by = NULL;
2956     ti->tested_by = NULL;
2957
2958     ti->graphics_set_ecs = NULL;
2959     ti->graphics_set_aga = NULL;
2960     ti->graphics_set = NULL;
2961     ti->sounds_set_default = NULL;
2962     ti->sounds_set_lowpass = NULL;
2963     ti->sounds_set = NULL;
2964     ti->music_set = NULL;
2965     ti->graphics_path = getStringCopy(UNDEFINED_FILENAME);
2966     ti->sounds_path = getStringCopy(UNDEFINED_FILENAME);
2967     ti->music_path = getStringCopy(UNDEFINED_FILENAME);
2968
2969     ti->level_filename = NULL;
2970     ti->level_filetype = NULL;
2971
2972     ti->special_flags = NULL;
2973
2974     ti->empty_level_name = NULL;
2975     ti->force_level_name = FALSE;
2976
2977     ti->levels = 0;
2978     ti->first_level = 0;
2979     ti->last_level = 0;
2980     ti->level_group = FALSE;
2981     ti->handicap_level = 0;
2982     ti->readonly = TRUE;
2983     ti->handicap = TRUE;
2984     ti->time_limit = TRUE;
2985     ti->skip_levels = FALSE;
2986
2987     ti->use_emc_tiles = FALSE;
2988     ti->info_screens_from_main = FALSE;
2989   }
2990 }
2991
2992 static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent)
2993 {
2994   if (parent == NULL)
2995   {
2996     Warn("setTreeInfoToDefaultsFromParent(): parent == NULL");
2997
2998     setTreeInfoToDefaults(ti, TREE_TYPE_UNDEFINED);
2999
3000     return;
3001   }
3002
3003   // copy all values from the parent structure
3004
3005   ti->type = parent->type;
3006
3007   ti->node_top = parent->node_top;
3008   ti->node_parent = parent;
3009   ti->node_group = NULL;
3010   ti->next = NULL;
3011
3012   ti->cl_first = -1;
3013   ti->cl_cursor = -1;
3014
3015   ti->subdir = NULL;
3016   ti->fullpath = NULL;
3017   ti->basepath = NULL;
3018   ti->identifier = NULL;
3019   ti->name = getStringCopy(ANONYMOUS_NAME);
3020   ti->name_sorting = NULL;
3021   ti->author = getStringCopy(parent->author);
3022   ti->year = getStringCopy(parent->year);
3023
3024   ti->program_title = getStringCopy(parent->program_title);
3025   ti->program_copyright = getStringCopy(parent->program_copyright);
3026   ti->program_company = getStringCopy(parent->program_company);
3027
3028   ti->sort_priority = parent->sort_priority;
3029   ti->latest_engine = parent->latest_engine;
3030   ti->parent_link = FALSE;
3031   ti->is_copy = FALSE;
3032   ti->in_user_dir = parent->in_user_dir;
3033   ti->user_defined = parent->user_defined;
3034   ti->color = parent->color;
3035   ti->class_desc = getStringCopy(parent->class_desc);
3036
3037   ti->infotext = getStringCopy(parent->infotext);
3038
3039   if (ti->type == TREE_TYPE_LEVEL_DIR)
3040   {
3041     ti->imported_from = getStringCopy(parent->imported_from);
3042     ti->imported_by = getStringCopy(parent->imported_by);
3043     ti->tested_by = getStringCopy(parent->tested_by);
3044
3045     ti->graphics_set_ecs = getStringCopy(parent->graphics_set_ecs);
3046     ti->graphics_set_aga = getStringCopy(parent->graphics_set_aga);
3047     ti->graphics_set = getStringCopy(parent->graphics_set);
3048     ti->sounds_set_default = getStringCopy(parent->sounds_set_default);
3049     ti->sounds_set_lowpass = getStringCopy(parent->sounds_set_lowpass);
3050     ti->sounds_set = getStringCopy(parent->sounds_set);
3051     ti->music_set = getStringCopy(parent->music_set);
3052     ti->graphics_path = getStringCopy(UNDEFINED_FILENAME);
3053     ti->sounds_path = getStringCopy(UNDEFINED_FILENAME);
3054     ti->music_path = getStringCopy(UNDEFINED_FILENAME);
3055
3056     ti->level_filename = getStringCopy(parent->level_filename);
3057     ti->level_filetype = getStringCopy(parent->level_filetype);
3058
3059     ti->special_flags = getStringCopy(parent->special_flags);
3060
3061     ti->empty_level_name = getStringCopy(parent->empty_level_name);
3062     ti->force_level_name = parent->force_level_name;
3063
3064     ti->levels = parent->levels;
3065     ti->first_level = parent->first_level;
3066     ti->last_level = parent->last_level;
3067     ti->level_group = FALSE;
3068     ti->handicap_level = parent->handicap_level;
3069     ti->readonly = parent->readonly;
3070     ti->handicap = parent->handicap;
3071     ti->time_limit = parent->time_limit;
3072     ti->skip_levels = parent->skip_levels;
3073
3074     ti->use_emc_tiles = parent->use_emc_tiles;
3075     ti->info_screens_from_main = parent->info_screens_from_main;
3076   }
3077 }
3078
3079 static TreeInfo *getTreeInfoCopy(TreeInfo *ti)
3080 {
3081   TreeInfo *ti_copy = newTreeInfo();
3082
3083   // copy all values from the original structure
3084
3085   ti_copy->type                 = ti->type;
3086
3087   ti_copy->node_top             = ti->node_top;
3088   ti_copy->node_parent          = ti->node_parent;
3089   ti_copy->node_group           = ti->node_group;
3090   ti_copy->next                 = ti->next;
3091
3092   ti_copy->cl_first             = ti->cl_first;
3093   ti_copy->cl_cursor            = ti->cl_cursor;
3094
3095   ti_copy->subdir               = getStringCopy(ti->subdir);
3096   ti_copy->fullpath             = getStringCopy(ti->fullpath);
3097   ti_copy->basepath             = getStringCopy(ti->basepath);
3098   ti_copy->identifier           = getStringCopy(ti->identifier);
3099   ti_copy->name                 = getStringCopy(ti->name);
3100   ti_copy->name_sorting         = getStringCopy(ti->name_sorting);
3101   ti_copy->author               = getStringCopy(ti->author);
3102   ti_copy->year                 = getStringCopy(ti->year);
3103
3104   ti_copy->program_title        = getStringCopy(ti->program_title);
3105   ti_copy->program_copyright    = getStringCopy(ti->program_copyright);
3106   ti_copy->program_company      = getStringCopy(ti->program_company);
3107
3108   ti_copy->imported_from        = getStringCopy(ti->imported_from);
3109   ti_copy->imported_by          = getStringCopy(ti->imported_by);
3110   ti_copy->tested_by            = getStringCopy(ti->tested_by);
3111
3112   ti_copy->graphics_set_ecs     = getStringCopy(ti->graphics_set_ecs);
3113   ti_copy->graphics_set_aga     = getStringCopy(ti->graphics_set_aga);
3114   ti_copy->graphics_set         = getStringCopy(ti->graphics_set);
3115   ti_copy->sounds_set_default   = getStringCopy(ti->sounds_set_default);
3116   ti_copy->sounds_set_lowpass   = getStringCopy(ti->sounds_set_lowpass);
3117   ti_copy->sounds_set           = getStringCopy(ti->sounds_set);
3118   ti_copy->music_set            = getStringCopy(ti->music_set);
3119   ti_copy->graphics_path        = getStringCopy(ti->graphics_path);
3120   ti_copy->sounds_path          = getStringCopy(ti->sounds_path);
3121   ti_copy->music_path           = getStringCopy(ti->music_path);
3122
3123   ti_copy->level_filename       = getStringCopy(ti->level_filename);
3124   ti_copy->level_filetype       = getStringCopy(ti->level_filetype);
3125
3126   ti_copy->special_flags        = getStringCopy(ti->special_flags);
3127
3128   ti_copy->empty_level_name     = getStringCopy(ti->empty_level_name);
3129   ti_copy->force_level_name     = ti->force_level_name;
3130
3131   ti_copy->levels               = ti->levels;
3132   ti_copy->first_level          = ti->first_level;
3133   ti_copy->last_level           = ti->last_level;
3134   ti_copy->sort_priority        = ti->sort_priority;
3135
3136   ti_copy->latest_engine        = ti->latest_engine;
3137
3138   ti_copy->level_group          = ti->level_group;
3139   ti_copy->parent_link          = ti->parent_link;
3140   ti_copy->is_copy              = ti->is_copy;
3141   ti_copy->in_user_dir          = ti->in_user_dir;
3142   ti_copy->user_defined         = ti->user_defined;
3143   ti_copy->readonly             = ti->readonly;
3144   ti_copy->handicap             = ti->handicap;
3145   ti_copy->time_limit           = ti->time_limit;
3146   ti_copy->skip_levels          = ti->skip_levels;
3147
3148   ti_copy->use_emc_tiles        = ti->use_emc_tiles;
3149   ti_copy->info_screens_from_main = ti->info_screens_from_main;
3150
3151   ti_copy->color                = ti->color;
3152   ti_copy->class_desc           = getStringCopy(ti->class_desc);
3153   ti_copy->handicap_level       = ti->handicap_level;
3154
3155   ti_copy->infotext             = getStringCopy(ti->infotext);
3156
3157   return ti_copy;
3158 }
3159
3160 void freeTreeInfo(TreeInfo *ti)
3161 {
3162   if (ti == NULL)
3163     return;
3164
3165   checked_free(ti->subdir);
3166   checked_free(ti->fullpath);
3167   checked_free(ti->basepath);
3168   checked_free(ti->identifier);
3169
3170   checked_free(ti->name);
3171   checked_free(ti->name_sorting);
3172   checked_free(ti->author);
3173   checked_free(ti->year);
3174
3175   checked_free(ti->program_title);
3176   checked_free(ti->program_copyright);
3177   checked_free(ti->program_company);
3178
3179   checked_free(ti->class_desc);
3180
3181   checked_free(ti->infotext);
3182
3183   if (ti->type == TREE_TYPE_LEVEL_DIR)
3184   {
3185     checked_free(ti->imported_from);
3186     checked_free(ti->imported_by);
3187     checked_free(ti->tested_by);
3188
3189     checked_free(ti->graphics_set_ecs);
3190     checked_free(ti->graphics_set_aga);
3191     checked_free(ti->graphics_set);
3192     checked_free(ti->sounds_set_default);
3193     checked_free(ti->sounds_set_lowpass);
3194     checked_free(ti->sounds_set);
3195     checked_free(ti->music_set);
3196
3197     checked_free(ti->graphics_path);
3198     checked_free(ti->sounds_path);
3199     checked_free(ti->music_path);
3200
3201     checked_free(ti->level_filename);
3202     checked_free(ti->level_filetype);
3203
3204     checked_free(ti->special_flags);
3205   }
3206
3207   // recursively free child node
3208   if (ti->node_group)
3209     freeTreeInfo(ti->node_group);
3210
3211   // recursively free next node
3212   if (ti->next)
3213     freeTreeInfo(ti->next);
3214
3215   checked_free(ti);
3216 }
3217
3218 void setSetupInfo(struct TokenInfo *token_info,
3219                   int token_nr, char *token_value)
3220 {
3221   int token_type = token_info[token_nr].type;
3222   void *setup_value = token_info[token_nr].value;
3223
3224   if (token_value == NULL)
3225     return;
3226
3227   // set setup field to corresponding token value
3228   switch (token_type)
3229   {
3230     case TYPE_BOOLEAN:
3231     case TYPE_SWITCH:
3232       *(boolean *)setup_value = get_boolean_from_string(token_value);
3233       break;
3234
3235     case TYPE_SWITCH_3_STATES:
3236       *(int *)setup_value = get_switch3_from_string(token_value);
3237       break;
3238
3239     case TYPE_KEY:
3240       *(Key *)setup_value = getKeyFromKeyName(token_value);
3241       break;
3242
3243     case TYPE_KEY_X11:
3244       *(Key *)setup_value = getKeyFromX11KeyName(token_value);
3245       break;
3246
3247     case TYPE_INTEGER:
3248       *(int *)setup_value = get_integer_from_string(token_value);
3249       break;
3250
3251     case TYPE_STRING:
3252       checked_free(*(char **)setup_value);
3253       *(char **)setup_value = getStringCopy(token_value);
3254       break;
3255
3256     case TYPE_PLAYER:
3257       *(int *)setup_value = get_player_nr_from_string(token_value);
3258       break;
3259
3260     default:
3261       break;
3262   }
3263 }
3264
3265 static int compareTreeInfoEntries(const void *object1, const void *object2)
3266 {
3267   const TreeInfo *entry1 = *((TreeInfo **)object1);
3268   const TreeInfo *entry2 = *((TreeInfo **)object2);
3269   int tree_sorting1 = TREE_SORTING(entry1);
3270   int tree_sorting2 = TREE_SORTING(entry2);
3271
3272   if (tree_sorting1 != tree_sorting2)
3273     return (tree_sorting1 - tree_sorting2);
3274   else
3275     return strcasecmp(entry1->name_sorting, entry2->name_sorting);
3276 }
3277
3278 static TreeInfo *createParentTreeInfoNode(TreeInfo *node_parent)
3279 {
3280   TreeInfo *ti_new;
3281
3282   if (node_parent == NULL)
3283     return NULL;
3284
3285   ti_new = newTreeInfo();
3286   setTreeInfoToDefaults(ti_new, node_parent->type);
3287
3288   ti_new->node_parent = node_parent;
3289   ti_new->parent_link = TRUE;
3290
3291   setString(&ti_new->identifier, node_parent->identifier);
3292   setString(&ti_new->name, BACKLINK_TEXT_PARENT);
3293   setString(&ti_new->name_sorting, ti_new->name);
3294
3295   setString(&ti_new->subdir, STRING_PARENT_DIRECTORY);
3296   setString(&ti_new->fullpath, node_parent->fullpath);
3297
3298   ti_new->sort_priority = LEVELCLASS_PARENT;
3299   ti_new->latest_engine = node_parent->latest_engine;
3300
3301   setString(&ti_new->class_desc, getLevelClassDescription(ti_new));
3302
3303   pushTreeInfo(&node_parent->node_group, ti_new);
3304
3305   return ti_new;
3306 }
3307
3308 static TreeInfo *createTopTreeInfoNode(TreeInfo *node_first)
3309 {
3310   if (node_first == NULL)
3311     return NULL;
3312
3313   TreeInfo *ti_new = newTreeInfo();
3314   int type = node_first->type;
3315
3316   setTreeInfoToDefaults(ti_new, type);
3317
3318   ti_new->node_parent = NULL;
3319   ti_new->parent_link = FALSE;
3320
3321   setString(&ti_new->identifier, "top_tree_node");
3322   setString(&ti_new->name, TREE_INFOTEXT(type));
3323   setString(&ti_new->name_sorting, ti_new->name);
3324
3325   setString(&ti_new->subdir, STRING_TOP_DIRECTORY);
3326   setString(&ti_new->fullpath, ".");
3327
3328   ti_new->sort_priority = LEVELCLASS_TOP;
3329   ti_new->latest_engine = node_first->latest_engine;
3330
3331   setString(&ti_new->class_desc, TREE_INFOTEXT(type));
3332
3333   ti_new->node_group = node_first;
3334   ti_new->level_group = TRUE;
3335
3336   TreeInfo *ti_new2 = createParentTreeInfoNode(ti_new);
3337
3338   setString(&ti_new2->name, TREE_BACKLINK_TEXT(type));
3339   setString(&ti_new2->name_sorting, ti_new2->name);
3340
3341   return ti_new;
3342 }
3343
3344 static void setTreeInfoParentNodes(TreeInfo *node, TreeInfo *node_parent)
3345 {
3346   while (node)
3347   {
3348     if (node->node_group)
3349       setTreeInfoParentNodes(node->node_group, node);
3350
3351     node->node_parent = node_parent;
3352
3353     node = node->next;
3354   }
3355 }
3356
3357 TreeInfo *addTopTreeInfoNode(TreeInfo *node_first)
3358 {
3359   // add top tree node with back link node in previous tree
3360   node_first = createTopTreeInfoNode(node_first);
3361
3362   // set all parent links (back links) in complete tree
3363   setTreeInfoParentNodes(node_first, NULL);
3364
3365   return node_first;
3366 }
3367
3368
3369 // ----------------------------------------------------------------------------
3370 // functions for handling level and custom artwork info cache
3371 // ----------------------------------------------------------------------------
3372
3373 static void LoadArtworkInfoCache(void)
3374 {
3375   InitCacheDirectory();
3376
3377   if (artworkinfo_cache_old == NULL)
3378   {
3379     char *filename = getPath2(getCacheDir(), ARTWORKINFO_CACHE_FILE);
3380
3381     // try to load artwork info hash from already existing cache file
3382     artworkinfo_cache_old = loadSetupFileHash(filename);
3383
3384     // try to get program version that artwork info cache was written with
3385     char *version = getHashEntry(artworkinfo_cache_old, "program.version");
3386
3387     // check program version of artwork info cache against current version
3388     if (!strEqual(version, program.version_string))
3389     {
3390       freeSetupFileHash(artworkinfo_cache_old);
3391
3392       artworkinfo_cache_old = NULL;
3393     }
3394
3395     // if no artwork info cache file was found, start with empty hash
3396     if (artworkinfo_cache_old == NULL)
3397       artworkinfo_cache_old = newSetupFileHash();
3398
3399     free(filename);
3400   }
3401
3402   if (artworkinfo_cache_new == NULL)
3403     artworkinfo_cache_new = newSetupFileHash();
3404
3405   update_artworkinfo_cache = FALSE;
3406 }
3407
3408 static void SaveArtworkInfoCache(void)
3409 {
3410   if (!update_artworkinfo_cache)
3411     return;
3412
3413   char *filename = getPath2(getCacheDir(), ARTWORKINFO_CACHE_FILE);
3414
3415   InitCacheDirectory();
3416
3417   saveSetupFileHash(artworkinfo_cache_new, filename);
3418
3419   free(filename);
3420 }
3421
3422 static char *getCacheTokenPrefix(char *prefix1, char *prefix2)
3423 {
3424   static char *prefix = NULL;
3425
3426   checked_free(prefix);
3427
3428   prefix = getStringCat2WithSeparator(prefix1, prefix2, ".");
3429
3430   return prefix;
3431 }
3432
3433 // (identical to above function, but separate string buffer needed -- nasty)
3434 static char *getCacheToken(char *prefix, char *suffix)
3435 {
3436   static char *token = NULL;
3437
3438   checked_free(token);
3439
3440   token = getStringCat2WithSeparator(prefix, suffix, ".");
3441
3442   return token;
3443 }
3444
3445 static char *getFileTimestampString(char *filename)
3446 {
3447   return getStringCopy(i_to_a(getFileTimestampEpochSeconds(filename)));
3448 }
3449
3450 static boolean modifiedFileTimestamp(char *filename, char *timestamp_string)
3451 {
3452   struct stat file_status;
3453
3454   if (timestamp_string == NULL)
3455     return TRUE;
3456
3457   if (!fileExists(filename))                    // file does not exist
3458     return (atoi(timestamp_string) != 0);
3459
3460   if (stat(filename, &file_status) != 0)        // cannot stat file
3461     return TRUE;
3462
3463   return (file_status.st_mtime != atoi(timestamp_string));
3464 }
3465
3466 static TreeInfo *getArtworkInfoCacheEntry(LevelDirTree *level_node, int type)
3467 {
3468   char *identifier = level_node->subdir;
3469   char *type_string = ARTWORK_DIRECTORY(type);
3470   char *token_prefix = getCacheTokenPrefix(type_string, identifier);
3471   char *token_main = getCacheToken(token_prefix, "CACHED");
3472   char *cache_entry = getHashEntry(artworkinfo_cache_old, token_main);
3473   boolean cached = (cache_entry != NULL && strEqual(cache_entry, "true"));
3474   TreeInfo *artwork_info = NULL;
3475
3476   if (!use_artworkinfo_cache)
3477     return NULL;
3478
3479   if (optional_tokens_hash == NULL)
3480   {
3481     int i;
3482
3483     // create hash from list of optional tokens (for quick access)
3484     optional_tokens_hash = newSetupFileHash();
3485     for (i = 0; optional_tokens[i] != NULL; i++)
3486       setHashEntry(optional_tokens_hash, optional_tokens[i], "");
3487   }
3488
3489   if (cached)
3490   {
3491     int i;
3492
3493     artwork_info = newTreeInfo();
3494     setTreeInfoToDefaults(artwork_info, type);
3495
3496     // set all structure fields according to the token/value pairs
3497     ldi = *artwork_info;
3498     for (i = 0; artworkinfo_tokens[i].type != -1; i++)
3499     {
3500       char *token_suffix = artworkinfo_tokens[i].text;
3501       char *token = getCacheToken(token_prefix, token_suffix);
3502       char *value = getHashEntry(artworkinfo_cache_old, token);
3503       boolean optional =
3504         (getHashEntry(optional_tokens_hash, token_suffix) != NULL);
3505
3506       setSetupInfo(artworkinfo_tokens, i, value);
3507
3508       // check if cache entry for this item is mandatory, but missing
3509       if (value == NULL && !optional)
3510       {
3511         Warn("missing cache entry '%s'", token);
3512
3513         cached = FALSE;
3514       }
3515     }
3516
3517     *artwork_info = ldi;
3518   }
3519
3520   if (cached)
3521   {
3522     char *filename_levelinfo = getPath2(getLevelDirFromTreeInfo(level_node),
3523                                         LEVELINFO_FILENAME);
3524     char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info),
3525                                           ARTWORKINFO_FILENAME(type));
3526
3527     // check if corresponding "levelinfo.conf" file has changed
3528     token_main = getCacheToken(token_prefix, "TIMESTAMP_LEVELINFO");
3529     cache_entry = getHashEntry(artworkinfo_cache_old, token_main);
3530
3531     if (modifiedFileTimestamp(filename_levelinfo, cache_entry))
3532       cached = FALSE;
3533
3534     // check if corresponding "<artworkinfo>.conf" file has changed
3535     token_main = getCacheToken(token_prefix, "TIMESTAMP_ARTWORKINFO");
3536     cache_entry = getHashEntry(artworkinfo_cache_old, token_main);
3537
3538     if (modifiedFileTimestamp(filename_artworkinfo, cache_entry))
3539       cached = FALSE;
3540
3541     checked_free(filename_levelinfo);
3542     checked_free(filename_artworkinfo);
3543   }
3544
3545   if (!cached && artwork_info != NULL)
3546   {
3547     freeTreeInfo(artwork_info);
3548
3549     return NULL;
3550   }
3551
3552   return artwork_info;
3553 }
3554
3555 static void setArtworkInfoCacheEntry(TreeInfo *artwork_info,
3556                                      LevelDirTree *level_node, int type)
3557 {
3558   char *identifier = level_node->subdir;
3559   char *type_string = ARTWORK_DIRECTORY(type);
3560   char *token_prefix = getCacheTokenPrefix(type_string, identifier);
3561   char *token_main = getCacheToken(token_prefix, "CACHED");
3562   boolean set_cache_timestamps = TRUE;
3563   int i;
3564
3565   setHashEntry(artworkinfo_cache_new, token_main, "true");
3566
3567   if (set_cache_timestamps)
3568   {
3569     char *filename_levelinfo = getPath2(getLevelDirFromTreeInfo(level_node),
3570                                         LEVELINFO_FILENAME);
3571     char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info),
3572                                           ARTWORKINFO_FILENAME(type));
3573     char *timestamp_levelinfo = getFileTimestampString(filename_levelinfo);
3574     char *timestamp_artworkinfo = getFileTimestampString(filename_artworkinfo);
3575
3576     token_main = getCacheToken(token_prefix, "TIMESTAMP_LEVELINFO");
3577     setHashEntry(artworkinfo_cache_new, token_main, timestamp_levelinfo);
3578
3579     token_main = getCacheToken(token_prefix, "TIMESTAMP_ARTWORKINFO");
3580     setHashEntry(artworkinfo_cache_new, token_main, timestamp_artworkinfo);
3581
3582     checked_free(filename_levelinfo);
3583     checked_free(filename_artworkinfo);
3584     checked_free(timestamp_levelinfo);
3585     checked_free(timestamp_artworkinfo);
3586   }
3587
3588   ldi = *artwork_info;
3589   for (i = 0; artworkinfo_tokens[i].type != -1; i++)
3590   {
3591     char *token = getCacheToken(token_prefix, artworkinfo_tokens[i].text);
3592     char *value = getSetupValue(artworkinfo_tokens[i].type,
3593                                 artworkinfo_tokens[i].value);
3594     if (value != NULL)
3595       setHashEntry(artworkinfo_cache_new, token, value);
3596   }
3597 }
3598
3599
3600 // ----------------------------------------------------------------------------
3601 // functions for loading level info and custom artwork info
3602 // ----------------------------------------------------------------------------
3603
3604 int GetZipFileTreeType(char *zip_filename)
3605 {
3606   static char *top_dir_path = NULL;
3607   static char *top_dir_conf_filename[NUM_BASE_TREE_TYPES] = { NULL };
3608   static char *conf_basename[NUM_BASE_TREE_TYPES] =
3609   {
3610     GRAPHICSINFO_FILENAME,
3611     SOUNDSINFO_FILENAME,
3612     MUSICINFO_FILENAME,
3613     LEVELINFO_FILENAME
3614   };
3615   int j;
3616
3617   checked_free(top_dir_path);
3618   top_dir_path = NULL;
3619
3620   for (j = 0; j < NUM_BASE_TREE_TYPES; j++)
3621   {
3622     checked_free(top_dir_conf_filename[j]);
3623     top_dir_conf_filename[j] = NULL;
3624   }
3625
3626   char **zip_entries = zip_list(zip_filename);
3627
3628   // check if zip file successfully opened
3629   if (zip_entries == NULL || zip_entries[0] == NULL)
3630     return TREE_TYPE_UNDEFINED;
3631
3632   // first zip file entry is expected to be top level directory
3633   char *top_dir = zip_entries[0];
3634
3635   // check if valid top level directory found in zip file
3636   if (!strSuffix(top_dir, "/"))
3637     return TREE_TYPE_UNDEFINED;
3638
3639   // get filenames of valid configuration files in top level directory
3640   for (j = 0; j < NUM_BASE_TREE_TYPES; j++)
3641     top_dir_conf_filename[j] = getStringCat2(top_dir, conf_basename[j]);
3642
3643   int tree_type = TREE_TYPE_UNDEFINED;
3644   int e = 0;
3645
3646   while (zip_entries[e] != NULL)
3647   {
3648     // check if every zip file entry is below top level directory
3649     if (!strPrefix(zip_entries[e], top_dir))
3650       return TREE_TYPE_UNDEFINED;
3651
3652     // check if this zip file entry is a valid configuration filename
3653     for (j = 0; j < NUM_BASE_TREE_TYPES; j++)
3654     {
3655       if (strEqual(zip_entries[e], top_dir_conf_filename[j]))
3656       {
3657         // only exactly one valid configuration file allowed
3658         if (tree_type != TREE_TYPE_UNDEFINED)
3659           return TREE_TYPE_UNDEFINED;
3660
3661         tree_type = j;
3662       }
3663     }
3664
3665     e++;
3666   }
3667
3668   return tree_type;
3669 }
3670
3671 static boolean CheckZipFileForDirectory(char *zip_filename, char *directory,
3672                                         int tree_type)
3673 {
3674   static char *top_dir_path = NULL;
3675   static char *top_dir_conf_filename = NULL;
3676
3677   checked_free(top_dir_path);
3678   checked_free(top_dir_conf_filename);
3679
3680   top_dir_path = NULL;
3681   top_dir_conf_filename = NULL;
3682
3683   char *conf_basename = (tree_type == TREE_TYPE_LEVEL_DIR ? LEVELINFO_FILENAME :
3684                          ARTWORKINFO_FILENAME(tree_type));
3685
3686   // check if valid configuration filename determined
3687   if (conf_basename == NULL || strEqual(conf_basename, ""))
3688     return FALSE;
3689
3690   char **zip_entries = zip_list(zip_filename);
3691
3692   // check if zip file successfully opened
3693   if (zip_entries == NULL || zip_entries[0] == NULL)
3694     return FALSE;
3695
3696   // first zip file entry is expected to be top level directory
3697   char *top_dir = zip_entries[0];
3698
3699   // check if valid top level directory found in zip file
3700   if (!strSuffix(top_dir, "/"))
3701     return FALSE;
3702
3703   // get path of extracted top level directory
3704   top_dir_path = getPath2(directory, top_dir);
3705
3706   // remove trailing directory separator from top level directory path
3707   // (required to be able to check for file and directory in next step)
3708   top_dir_path[strlen(top_dir_path) - 1] = '\0';
3709
3710   // check if zip file's top level directory already exists in target directory
3711   if (fileExists(top_dir_path))         // (checks for file and directory)
3712     return FALSE;
3713
3714   // get filename of configuration file in top level directory
3715   top_dir_conf_filename = getStringCat2(top_dir, conf_basename);
3716
3717   boolean found_top_dir_conf_filename = FALSE;
3718   int i = 0;
3719
3720   while (zip_entries[i] != NULL)
3721   {
3722     // check if every zip file entry is below top level directory
3723     if (!strPrefix(zip_entries[i], top_dir))
3724       return FALSE;
3725
3726     // check if this zip file entry is the configuration filename
3727     if (strEqual(zip_entries[i], top_dir_conf_filename))
3728       found_top_dir_conf_filename = TRUE;
3729
3730     i++;
3731   }
3732
3733   // check if valid configuration filename was found in zip file
3734   if (!found_top_dir_conf_filename)
3735     return FALSE;
3736
3737   return TRUE;
3738 }
3739
3740 char *ExtractZipFileIntoDirectory(char *zip_filename, char *directory,
3741                                   int tree_type)
3742 {
3743   boolean zip_file_valid = CheckZipFileForDirectory(zip_filename, directory,
3744                                                     tree_type);
3745
3746   if (!zip_file_valid)
3747   {
3748     Warn("zip file '%s' rejected!", zip_filename);
3749
3750     return NULL;
3751   }
3752
3753   char **zip_entries = zip_extract(zip_filename, directory);
3754
3755   if (zip_entries == NULL)
3756   {
3757     Warn("zip file '%s' could not be extracted!", zip_filename);
3758
3759     return NULL;
3760   }
3761
3762   Info("zip file '%s' successfully extracted!", zip_filename);
3763
3764   // first zip file entry contains top level directory
3765   char *top_dir = zip_entries[0];
3766
3767   // remove trailing directory separator from top level directory
3768   top_dir[strlen(top_dir) - 1] = '\0';
3769
3770   return top_dir;
3771 }
3772
3773 static void ProcessZipFilesInDirectory(char *directory, int tree_type)
3774 {
3775   Directory *dir;
3776   DirectoryEntry *dir_entry;
3777
3778   if ((dir = openDirectory(directory)) == NULL)
3779   {
3780     // display error if directory is main "options.graphics_directory" etc.
3781     if (tree_type == TREE_TYPE_LEVEL_DIR ||
3782         directory == OPTIONS_ARTWORK_DIRECTORY(tree_type))
3783       Warn("cannot read directory '%s'", directory);
3784
3785     return;
3786   }
3787
3788   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
3789   {
3790     // skip non-zip files (and also directories with zip extension)
3791     if (!strSuffixLower(dir_entry->basename, ".zip") || dir_entry->is_directory)
3792       continue;
3793
3794     char *zip_filename = getPath2(directory, dir_entry->basename);
3795     char *zip_filename_extracted = getStringCat2(zip_filename, ".extracted");
3796     char *zip_filename_rejected  = getStringCat2(zip_filename, ".rejected");
3797
3798     // check if zip file hasn't already been extracted or rejected
3799     if (!fileExists(zip_filename_extracted) &&
3800         !fileExists(zip_filename_rejected))
3801     {
3802       char *top_dir = ExtractZipFileIntoDirectory(zip_filename, directory,
3803                                                   tree_type);
3804       char *marker_filename = (top_dir != NULL ? zip_filename_extracted :
3805                                zip_filename_rejected);
3806       FILE *marker_file;
3807
3808       // create empty file to mark zip file as extracted or rejected
3809       if ((marker_file = fopen(marker_filename, MODE_WRITE)))
3810         fclose(marker_file);
3811
3812       free(zip_filename);
3813       free(zip_filename_extracted);
3814       free(zip_filename_rejected);
3815     }
3816   }
3817
3818   closeDirectory(dir);
3819 }
3820
3821 // forward declaration for recursive call by "LoadLevelInfoFromLevelDir()"
3822 static void LoadLevelInfoFromLevelDir(TreeInfo **, TreeInfo *, char *);
3823
3824 static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first,
3825                                           TreeInfo *node_parent,
3826                                           char *level_directory,
3827                                           char *directory_name)
3828 {
3829   char *directory_path = getPath2(level_directory, directory_name);
3830   char *filename = getPath2(directory_path, LEVELINFO_FILENAME);
3831   SetupFileHash *setup_file_hash;
3832   LevelDirTree *leveldir_new = NULL;
3833   int i;
3834
3835   // unless debugging, silently ignore directories without "levelinfo.conf"
3836   if (!options.debug && !fileExists(filename))
3837   {
3838     free(directory_path);
3839     free(filename);
3840
3841     return FALSE;
3842   }
3843
3844   setup_file_hash = loadSetupFileHash(filename);
3845
3846   if (setup_file_hash == NULL)
3847   {
3848 #if DEBUG_NO_CONFIG_FILE
3849     Debug("setup", "ignoring level directory '%s'", directory_path);
3850 #endif
3851
3852     free(directory_path);
3853     free(filename);
3854
3855     return FALSE;
3856   }
3857
3858   leveldir_new = newTreeInfo();
3859
3860   if (node_parent)
3861     setTreeInfoToDefaultsFromParent(leveldir_new, node_parent);
3862   else
3863     setTreeInfoToDefaults(leveldir_new, TREE_TYPE_LEVEL_DIR);
3864
3865   leveldir_new->subdir = getStringCopy(directory_name);
3866
3867   // set all structure fields according to the token/value pairs
3868   ldi = *leveldir_new;
3869   for (i = 0; i < NUM_LEVELINFO_TOKENS; i++)
3870     setSetupInfo(levelinfo_tokens, i,
3871                  getHashEntry(setup_file_hash, levelinfo_tokens[i].text));
3872   *leveldir_new = ldi;
3873
3874   if (strEqual(leveldir_new->name, ANONYMOUS_NAME))
3875     setString(&leveldir_new->name, leveldir_new->subdir);
3876
3877   if (leveldir_new->identifier == NULL)
3878     leveldir_new->identifier = getStringCopy(leveldir_new->subdir);
3879
3880   if (leveldir_new->name_sorting == NULL)
3881     leveldir_new->name_sorting = getStringCopy(leveldir_new->name);
3882
3883   if (node_parent == NULL)              // top level group
3884   {
3885     leveldir_new->basepath = getStringCopy(level_directory);
3886     leveldir_new->fullpath = getStringCopy(leveldir_new->subdir);
3887   }
3888   else                                  // sub level group
3889   {
3890     leveldir_new->basepath = getStringCopy(node_parent->basepath);
3891     leveldir_new->fullpath = getPath2(node_parent->fullpath, directory_name);
3892   }
3893
3894   leveldir_new->last_level =
3895     leveldir_new->first_level + leveldir_new->levels - 1;
3896
3897   leveldir_new->in_user_dir =
3898     (!strEqual(leveldir_new->basepath, options.level_directory));
3899
3900   // adjust some settings if user's private level directory was detected
3901   if (leveldir_new->sort_priority == LEVELCLASS_UNDEFINED &&
3902       leveldir_new->in_user_dir &&
3903       (strEqual(leveldir_new->subdir, getLoginName()) ||
3904        strEqual(leveldir_new->name,   getLoginName()) ||
3905        strEqual(leveldir_new->author, getRealName())))
3906   {
3907     leveldir_new->sort_priority = LEVELCLASS_PRIVATE_START;
3908     leveldir_new->readonly = FALSE;
3909   }
3910
3911   leveldir_new->user_defined =
3912     (leveldir_new->in_user_dir && IS_LEVELCLASS_PRIVATE(leveldir_new));
3913
3914   setString(&leveldir_new->class_desc, getLevelClassDescription(leveldir_new));
3915
3916   leveldir_new->handicap_level =        // set handicap to default value
3917     (leveldir_new->user_defined || !leveldir_new->handicap ?
3918      leveldir_new->last_level : leveldir_new->first_level);
3919
3920   DrawInitTextItem(leveldir_new->name);
3921
3922   pushTreeInfo(node_first, leveldir_new);
3923
3924   freeSetupFileHash(setup_file_hash);
3925
3926   if (leveldir_new->level_group)
3927   {
3928     // create node to link back to current level directory
3929     createParentTreeInfoNode(leveldir_new);
3930
3931     // recursively step into sub-directory and look for more level series
3932     LoadLevelInfoFromLevelDir(&leveldir_new->node_group,
3933                               leveldir_new, directory_path);
3934   }
3935
3936   free(directory_path);
3937   free(filename);
3938
3939   return TRUE;
3940 }
3941
3942 static void LoadLevelInfoFromLevelDir(TreeInfo **node_first,
3943                                       TreeInfo *node_parent,
3944                                       char *level_directory)
3945 {
3946   // ---------- 1st stage: process any level set zip files ----------
3947
3948   ProcessZipFilesInDirectory(level_directory, TREE_TYPE_LEVEL_DIR);
3949
3950   // ---------- 2nd stage: check for level set directories ----------
3951
3952   Directory *dir;
3953   DirectoryEntry *dir_entry;
3954   boolean valid_entry_found = FALSE;
3955
3956   if ((dir = openDirectory(level_directory)) == NULL)
3957   {
3958     Warn("cannot read level directory '%s'", level_directory);
3959
3960     return;
3961   }
3962
3963   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
3964   {
3965     char *directory_name = dir_entry->basename;
3966     char *directory_path = getPath2(level_directory, directory_name);
3967
3968     // skip entries for current and parent directory
3969     if (strEqual(directory_name, ".") ||
3970         strEqual(directory_name, ".."))
3971     {
3972       free(directory_path);
3973
3974       continue;
3975     }
3976
3977     // find out if directory entry is itself a directory
3978     if (!dir_entry->is_directory)                       // not a directory
3979     {
3980       free(directory_path);
3981
3982       continue;
3983     }
3984
3985     free(directory_path);
3986
3987     if (strEqual(directory_name, GRAPHICS_DIRECTORY) ||
3988         strEqual(directory_name, SOUNDS_DIRECTORY) ||
3989         strEqual(directory_name, MUSIC_DIRECTORY))
3990       continue;
3991
3992     valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent,
3993                                                     level_directory,
3994                                                     directory_name);
3995   }
3996
3997   closeDirectory(dir);
3998
3999   // special case: top level directory may directly contain "levelinfo.conf"
4000   if (node_parent == NULL && !valid_entry_found)
4001   {
4002     // check if this directory directly contains a file "levelinfo.conf"
4003     valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent,
4004                                                     level_directory, ".");
4005   }
4006
4007   boolean valid_entry_expected =
4008     (strEqual(level_directory, options.level_directory) ||
4009      setup.internal.create_user_levelset);
4010
4011   if (valid_entry_expected && !valid_entry_found)
4012     Warn("cannot find any valid level series in directory '%s'",
4013          level_directory);
4014 }
4015
4016 boolean AdjustGraphicsForEMC(void)
4017 {
4018   boolean settings_changed = FALSE;
4019
4020   settings_changed |= adjustTreeGraphicsForEMC(leveldir_first_all);
4021   settings_changed |= adjustTreeGraphicsForEMC(leveldir_first);
4022
4023   return settings_changed;
4024 }
4025
4026 boolean AdjustSoundsForEMC(void)
4027 {
4028   boolean settings_changed = FALSE;
4029
4030   settings_changed |= adjustTreeSoundsForEMC(leveldir_first_all);
4031   settings_changed |= adjustTreeSoundsForEMC(leveldir_first);
4032
4033   return settings_changed;
4034 }
4035
4036 void LoadLevelInfo(void)
4037 {
4038   InitUserLevelDirectory(getLoginName());
4039
4040   DrawInitTextHead("Loading level series");
4041
4042   LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory);
4043   LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir(NULL));
4044
4045   leveldir_first = createTopTreeInfoNode(leveldir_first);
4046
4047   /* after loading all level set information, clone the level directory tree
4048      and remove all level sets without levels (these may still contain artwork
4049      to be offered in the setup menu as "custom artwork", and are therefore
4050      checked for existing artwork in the function "LoadLevelArtworkInfo()") */
4051   leveldir_first_all = leveldir_first;
4052   cloneTree(&leveldir_first, leveldir_first_all, TRUE);
4053
4054   AdjustGraphicsForEMC();
4055   AdjustSoundsForEMC();
4056
4057   // before sorting, the first entries will be from the user directory
4058   leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
4059
4060   if (leveldir_first == NULL)
4061     Fail("cannot find any valid level series in any directory");
4062
4063   sortTreeInfo(&leveldir_first);
4064
4065 #if ENABLE_UNUSED_CODE
4066   dumpTreeInfo(leveldir_first, 0);
4067 #endif
4068 }
4069
4070 static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
4071                                               TreeInfo *node_parent,
4072                                               char *base_directory,
4073                                               char *directory_name, int type)
4074 {
4075   char *directory_path = getPath2(base_directory, directory_name);
4076   char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type));
4077   SetupFileHash *setup_file_hash = NULL;
4078   TreeInfo *artwork_new = NULL;
4079   int i;
4080
4081   if (fileExists(filename))
4082     setup_file_hash = loadSetupFileHash(filename);
4083
4084   if (setup_file_hash == NULL)  // no config file -- look for artwork files
4085   {
4086     Directory *dir;
4087     DirectoryEntry *dir_entry;
4088     boolean valid_file_found = FALSE;
4089
4090     if ((dir = openDirectory(directory_path)) != NULL)
4091     {
4092       while ((dir_entry = readDirectory(dir)) != NULL)
4093       {
4094         if (FileIsArtworkType(dir_entry->filename, type))
4095         {
4096           valid_file_found = TRUE;
4097
4098           break;
4099         }
4100       }
4101
4102       closeDirectory(dir);
4103     }
4104
4105     if (!valid_file_found)
4106     {
4107 #if DEBUG_NO_CONFIG_FILE
4108       if (!strEqual(directory_name, "."))
4109         Debug("setup", "ignoring artwork directory '%s'", directory_path);
4110 #endif
4111
4112       free(directory_path);
4113       free(filename);
4114
4115       return FALSE;
4116     }
4117   }
4118
4119   artwork_new = newTreeInfo();
4120
4121   if (node_parent)
4122     setTreeInfoToDefaultsFromParent(artwork_new, node_parent);
4123   else
4124     setTreeInfoToDefaults(artwork_new, type);
4125
4126   artwork_new->subdir = getStringCopy(directory_name);
4127
4128   if (setup_file_hash)  // (before defining ".color" and ".class_desc")
4129   {
4130     // set all structure fields according to the token/value pairs
4131     ldi = *artwork_new;
4132     for (i = 0; i < NUM_LEVELINFO_TOKENS; i++)
4133       setSetupInfo(levelinfo_tokens, i,
4134                    getHashEntry(setup_file_hash, levelinfo_tokens[i].text));
4135     *artwork_new = ldi;
4136
4137     if (strEqual(artwork_new->name, ANONYMOUS_NAME))
4138       setString(&artwork_new->name, artwork_new->subdir);
4139
4140     if (artwork_new->identifier == NULL)
4141       artwork_new->identifier = getStringCopy(artwork_new->subdir);
4142
4143     if (artwork_new->name_sorting == NULL)
4144       artwork_new->name_sorting = getStringCopy(artwork_new->name);
4145   }
4146
4147   if (node_parent == NULL)              // top level group
4148   {
4149     artwork_new->basepath = getStringCopy(base_directory);
4150     artwork_new->fullpath = getStringCopy(artwork_new->subdir);
4151   }
4152   else                                  // sub level group
4153   {
4154     artwork_new->basepath = getStringCopy(node_parent->basepath);
4155     artwork_new->fullpath = getPath2(node_parent->fullpath, directory_name);
4156   }
4157
4158   artwork_new->in_user_dir =
4159     (!strEqual(artwork_new->basepath, OPTIONS_ARTWORK_DIRECTORY(type)));
4160
4161   setString(&artwork_new->class_desc, getLevelClassDescription(artwork_new));
4162
4163   if (setup_file_hash == NULL)  // (after determining ".user_defined")
4164   {
4165     if (strEqual(artwork_new->subdir, "."))
4166     {
4167       if (artwork_new->user_defined)
4168       {
4169         setString(&artwork_new->identifier, "private");
4170         artwork_new->sort_priority = ARTWORKCLASS_PRIVATE;
4171       }
4172       else
4173       {
4174         setString(&artwork_new->identifier, "classic");
4175         artwork_new->sort_priority = ARTWORKCLASS_CLASSICS;
4176       }
4177
4178       setString(&artwork_new->class_desc,
4179                 getLevelClassDescription(artwork_new));
4180     }
4181     else
4182     {
4183       setString(&artwork_new->identifier, artwork_new->subdir);
4184     }
4185
4186     setString(&artwork_new->name, artwork_new->identifier);
4187     setString(&artwork_new->name_sorting, artwork_new->name);
4188   }
4189
4190   pushTreeInfo(node_first, artwork_new);
4191
4192   freeSetupFileHash(setup_file_hash);
4193
4194   free(directory_path);
4195   free(filename);
4196
4197   return TRUE;
4198 }
4199
4200 static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first,
4201                                           TreeInfo *node_parent,
4202                                           char *base_directory, int type)
4203 {
4204   // ---------- 1st stage: process any artwork set zip files ----------
4205
4206   ProcessZipFilesInDirectory(base_directory, type);
4207
4208   // ---------- 2nd stage: check for artwork set directories ----------
4209
4210   Directory *dir;
4211   DirectoryEntry *dir_entry;
4212   boolean valid_entry_found = FALSE;
4213
4214   if ((dir = openDirectory(base_directory)) == NULL)
4215   {
4216     // display error if directory is main "options.graphics_directory" etc.
4217     if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type))
4218       Warn("cannot read directory '%s'", base_directory);
4219
4220     return;
4221   }
4222
4223   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
4224   {
4225     char *directory_name = dir_entry->basename;
4226     char *directory_path = getPath2(base_directory, directory_name);
4227
4228     // skip directory entries for current and parent directory
4229     if (strEqual(directory_name, ".") ||
4230         strEqual(directory_name, ".."))
4231     {
4232       free(directory_path);
4233
4234       continue;
4235     }
4236
4237     // skip directory entries which are not a directory
4238     if (!dir_entry->is_directory)                       // not a directory
4239     {
4240       free(directory_path);
4241
4242       continue;
4243     }
4244
4245     free(directory_path);
4246
4247     // check if this directory contains artwork with or without config file
4248     valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent,
4249                                                         base_directory,
4250                                                         directory_name, type);
4251   }
4252
4253   closeDirectory(dir);
4254
4255   // check if this directory directly contains artwork itself
4256   valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent,
4257                                                       base_directory, ".",
4258                                                       type);
4259   if (!valid_entry_found)
4260     Warn("cannot find any valid artwork in directory '%s'", base_directory);
4261 }
4262
4263 static TreeInfo *getDummyArtworkInfo(int type)
4264 {
4265   // this is only needed when there is completely no artwork available
4266   TreeInfo *artwork_new = newTreeInfo();
4267
4268   setTreeInfoToDefaults(artwork_new, type);
4269
4270   setString(&artwork_new->subdir,   UNDEFINED_FILENAME);
4271   setString(&artwork_new->fullpath, UNDEFINED_FILENAME);
4272   setString(&artwork_new->basepath, UNDEFINED_FILENAME);
4273
4274   setString(&artwork_new->identifier,   UNDEFINED_FILENAME);
4275   setString(&artwork_new->name,         UNDEFINED_FILENAME);
4276   setString(&artwork_new->name_sorting, UNDEFINED_FILENAME);
4277
4278   return artwork_new;
4279 }
4280
4281 void SetCurrentArtwork(int type)
4282 {
4283   ArtworkDirTree **current_ptr = ARTWORK_CURRENT_PTR(artwork, type);
4284   ArtworkDirTree *first_node = ARTWORK_FIRST_NODE(artwork, type);
4285   char *setup_set = SETUP_ARTWORK_SET(setup, type);
4286   char *default_subdir = ARTWORK_DEFAULT_SUBDIR(type);
4287
4288   // set current artwork to artwork configured in setup menu
4289   *current_ptr = getTreeInfoFromIdentifier(first_node, setup_set);
4290
4291   // if not found, set current artwork to default artwork
4292   if (*current_ptr == NULL)
4293     *current_ptr = getTreeInfoFromIdentifier(first_node, default_subdir);
4294
4295   // if not found, set current artwork to first artwork in tree
4296   if (*current_ptr == NULL)
4297     *current_ptr = getFirstValidTreeInfoEntry(first_node);
4298 }
4299
4300 void ChangeCurrentArtworkIfNeeded(int type)
4301 {
4302   char *current_identifier = ARTWORK_CURRENT_IDENTIFIER(artwork, type);
4303   char *setup_set = SETUP_ARTWORK_SET(setup, type);
4304
4305   if (!strEqual(current_identifier, setup_set))
4306     SetCurrentArtwork(type);
4307 }
4308
4309 void LoadArtworkInfo(void)
4310 {
4311   LoadArtworkInfoCache();
4312
4313   DrawInitTextHead("Looking for custom artwork");
4314
4315   LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL,
4316                                 options.graphics_directory,
4317                                 TREE_TYPE_GRAPHICS_DIR);
4318   LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL,
4319                                 getUserGraphicsDir(),
4320                                 TREE_TYPE_GRAPHICS_DIR);
4321
4322   LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL,
4323                                 options.sounds_directory,
4324                                 TREE_TYPE_SOUNDS_DIR);
4325   LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL,
4326                                 getUserSoundsDir(),
4327                                 TREE_TYPE_SOUNDS_DIR);
4328
4329   LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL,
4330                                 options.music_directory,
4331                                 TREE_TYPE_MUSIC_DIR);
4332   LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL,
4333                                 getUserMusicDir(),
4334                                 TREE_TYPE_MUSIC_DIR);
4335
4336   if (artwork.gfx_first == NULL)
4337     artwork.gfx_first = getDummyArtworkInfo(TREE_TYPE_GRAPHICS_DIR);
4338   if (artwork.snd_first == NULL)
4339     artwork.snd_first = getDummyArtworkInfo(TREE_TYPE_SOUNDS_DIR);
4340   if (artwork.mus_first == NULL)
4341     artwork.mus_first = getDummyArtworkInfo(TREE_TYPE_MUSIC_DIR);
4342
4343   // before sorting, the first entries will be from the user directory
4344   SetCurrentArtwork(ARTWORK_TYPE_GRAPHICS);
4345   SetCurrentArtwork(ARTWORK_TYPE_SOUNDS);
4346   SetCurrentArtwork(ARTWORK_TYPE_MUSIC);
4347
4348   artwork.gfx_current_identifier = artwork.gfx_current->identifier;
4349   artwork.snd_current_identifier = artwork.snd_current->identifier;
4350   artwork.mus_current_identifier = artwork.mus_current->identifier;
4351
4352 #if ENABLE_UNUSED_CODE
4353   Debug("setup:LoadArtworkInfo", "graphics set == %s",
4354         artwork.gfx_current_identifier);
4355   Debug("setup:LoadArtworkInfo", "sounds set == %s",
4356         artwork.snd_current_identifier);
4357   Debug("setup:LoadArtworkInfo", "music set == %s",
4358         artwork.mus_current_identifier);
4359 #endif
4360
4361   sortTreeInfo(&artwork.gfx_first);
4362   sortTreeInfo(&artwork.snd_first);
4363   sortTreeInfo(&artwork.mus_first);
4364
4365 #if ENABLE_UNUSED_CODE
4366   dumpTreeInfo(artwork.gfx_first, 0);
4367   dumpTreeInfo(artwork.snd_first, 0);
4368   dumpTreeInfo(artwork.mus_first, 0);
4369 #endif
4370 }
4371
4372 static void MoveArtworkInfoIntoSubTree(ArtworkDirTree **artwork_node)
4373 {
4374   ArtworkDirTree *artwork_new = newTreeInfo();
4375   char *top_node_name = "standalone artwork";
4376
4377   setTreeInfoToDefaults(artwork_new, (*artwork_node)->type);
4378
4379   artwork_new->level_group = TRUE;
4380
4381   setString(&artwork_new->identifier,   top_node_name);
4382   setString(&artwork_new->name,         top_node_name);
4383   setString(&artwork_new->name_sorting, top_node_name);
4384
4385   // create node to link back to current custom artwork directory
4386   createParentTreeInfoNode(artwork_new);
4387
4388   // move existing custom artwork tree into newly created sub-tree
4389   artwork_new->node_group->next = *artwork_node;
4390
4391   // change custom artwork tree to contain only newly created node
4392   *artwork_node = artwork_new;
4393 }
4394
4395 static void LoadArtworkInfoFromLevelInfoExt(ArtworkDirTree **artwork_node,
4396                                             ArtworkDirTree *node_parent,
4397                                             LevelDirTree *level_node,
4398                                             boolean empty_level_set_mode)
4399 {
4400   int type = (*artwork_node)->type;
4401
4402   // recursively check all level directories for artwork sub-directories
4403
4404   while (level_node)
4405   {
4406     boolean empty_level_set = (level_node->levels == 0);
4407
4408     // check all tree entries for artwork, but skip parent link entries
4409     if (!level_node->parent_link && empty_level_set == empty_level_set_mode)
4410     {
4411       TreeInfo *artwork_new = getArtworkInfoCacheEntry(level_node, type);
4412       boolean cached = (artwork_new != NULL);
4413
4414       if (cached)
4415       {
4416         pushTreeInfo(artwork_node, artwork_new);
4417       }
4418       else
4419       {
4420         TreeInfo *topnode_last = *artwork_node;
4421         char *path = getPath2(getLevelDirFromTreeInfo(level_node),
4422                               ARTWORK_DIRECTORY(type));
4423
4424         LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path, type);
4425
4426         if (topnode_last != *artwork_node)      // check for newly added node
4427         {
4428           artwork_new = *artwork_node;
4429
4430           setString(&artwork_new->identifier,   level_node->subdir);
4431           setString(&artwork_new->name,         level_node->name);
4432           setString(&artwork_new->name_sorting, level_node->name_sorting);
4433
4434           artwork_new->sort_priority = level_node->sort_priority;
4435           artwork_new->in_user_dir = level_node->in_user_dir;
4436
4437           update_artworkinfo_cache = TRUE;
4438         }
4439
4440         free(path);
4441       }
4442
4443       // insert artwork info (from old cache or filesystem) into new cache
4444       if (artwork_new != NULL)
4445         setArtworkInfoCacheEntry(artwork_new, level_node, type);
4446     }
4447
4448     DrawInitTextItem(level_node->name);
4449
4450     if (level_node->node_group != NULL)
4451     {
4452       TreeInfo *artwork_new = newTreeInfo();
4453
4454       if (node_parent)
4455         setTreeInfoToDefaultsFromParent(artwork_new, node_parent);
4456       else
4457         setTreeInfoToDefaults(artwork_new, type);
4458
4459       artwork_new->level_group = TRUE;
4460
4461       setString(&artwork_new->identifier,   level_node->subdir);
4462
4463       if (node_parent == NULL)          // check for top tree node
4464       {
4465         char *top_node_name = (empty_level_set_mode ?
4466                                "artwork for certain level sets" :
4467                                "artwork included in level sets");
4468
4469         setString(&artwork_new->name,         top_node_name);
4470         setString(&artwork_new->name_sorting, top_node_name);
4471       }
4472       else
4473       {
4474         setString(&artwork_new->name,         level_node->name);
4475         setString(&artwork_new->name_sorting, level_node->name_sorting);
4476       }
4477
4478       pushTreeInfo(artwork_node, artwork_new);
4479
4480       // create node to link back to current custom artwork directory
4481       createParentTreeInfoNode(artwork_new);
4482
4483       // recursively step into sub-directory and look for more custom artwork
4484       LoadArtworkInfoFromLevelInfoExt(&artwork_new->node_group, artwork_new,
4485                                       level_node->node_group,
4486                                       empty_level_set_mode);
4487
4488       // if sub-tree has no custom artwork at all, remove it
4489       if (artwork_new->node_group->next == NULL)
4490         removeTreeInfo(artwork_node);
4491     }
4492
4493     level_node = level_node->next;
4494   }
4495 }
4496
4497 static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node)
4498 {
4499   // move peviously loaded artwork tree into separate sub-tree
4500   MoveArtworkInfoIntoSubTree(artwork_node);
4501
4502   // load artwork from level sets into separate sub-trees
4503   LoadArtworkInfoFromLevelInfoExt(artwork_node, NULL, leveldir_first_all, TRUE);
4504   LoadArtworkInfoFromLevelInfoExt(artwork_node, NULL, leveldir_first_all, FALSE);
4505
4506   // add top tree node over all sub-trees and set parent links
4507   *artwork_node = addTopTreeInfoNode(*artwork_node);
4508 }
4509
4510 void LoadLevelArtworkInfo(void)
4511 {
4512   print_timestamp_init("LoadLevelArtworkInfo");
4513
4514   DrawInitTextHead("Looking for custom level artwork");
4515
4516   print_timestamp_time("DrawTimeText");
4517
4518   LoadArtworkInfoFromLevelInfo(&artwork.gfx_first);
4519   print_timestamp_time("LoadArtworkInfoFromLevelInfo (gfx)");
4520   LoadArtworkInfoFromLevelInfo(&artwork.snd_first);
4521   print_timestamp_time("LoadArtworkInfoFromLevelInfo (snd)");
4522   LoadArtworkInfoFromLevelInfo(&artwork.mus_first);
4523   print_timestamp_time("LoadArtworkInfoFromLevelInfo (mus)");
4524
4525   SaveArtworkInfoCache();
4526
4527   print_timestamp_time("SaveArtworkInfoCache");
4528
4529   // needed for reloading level artwork not known at ealier stage
4530   ChangeCurrentArtworkIfNeeded(ARTWORK_TYPE_GRAPHICS);
4531   ChangeCurrentArtworkIfNeeded(ARTWORK_TYPE_SOUNDS);
4532   ChangeCurrentArtworkIfNeeded(ARTWORK_TYPE_MUSIC);
4533
4534   print_timestamp_time("getTreeInfoFromIdentifier");
4535
4536   sortTreeInfo(&artwork.gfx_first);
4537   sortTreeInfo(&artwork.snd_first);
4538   sortTreeInfo(&artwork.mus_first);
4539
4540   print_timestamp_time("sortTreeInfo");
4541
4542 #if ENABLE_UNUSED_CODE
4543   dumpTreeInfo(artwork.gfx_first, 0);
4544   dumpTreeInfo(artwork.snd_first, 0);
4545   dumpTreeInfo(artwork.mus_first, 0);
4546 #endif
4547
4548   print_timestamp_done("LoadLevelArtworkInfo");
4549 }
4550
4551 static boolean AddTreeSetToTreeInfoExt(TreeInfo *tree_node_old, char *tree_dir,
4552                                        char *tree_subdir_new, int type)
4553 {
4554   if (tree_node_old == NULL)
4555   {
4556     if (type == TREE_TYPE_LEVEL_DIR)
4557     {
4558       // get level info tree node of personal user level set
4559       tree_node_old = getTreeInfoFromIdentifier(leveldir_first, getLoginName());
4560
4561       // this may happen if "setup.internal.create_user_levelset" is FALSE
4562       // or if file "levelinfo.conf" is missing in personal user level set
4563       if (tree_node_old == NULL)
4564         tree_node_old = leveldir_first->node_group;
4565     }
4566     else
4567     {
4568       // get artwork info tree node of first artwork set
4569       tree_node_old = ARTWORK_FIRST_NODE(artwork, type);
4570     }
4571   }
4572
4573   if (tree_dir == NULL)
4574     tree_dir = TREE_USERDIR(type);
4575
4576   if (tree_node_old   == NULL ||
4577       tree_dir        == NULL ||
4578       tree_subdir_new == NULL)          // should not happen
4579     return FALSE;
4580
4581   int draw_deactivation_mask = GetDrawDeactivationMask();
4582
4583   // override draw deactivation mask (temporarily disable drawing)
4584   SetDrawDeactivationMask(REDRAW_ALL);
4585
4586   if (type == TREE_TYPE_LEVEL_DIR)
4587   {
4588     // load new level set config and add it next to first user level set
4589     LoadLevelInfoFromLevelConf(&tree_node_old->next,
4590                                tree_node_old->node_parent,
4591                                tree_dir, tree_subdir_new);
4592   }
4593   else
4594   {
4595     // load new artwork set config and add it next to first artwork set
4596     LoadArtworkInfoFromArtworkConf(&tree_node_old->next,
4597                                    tree_node_old->node_parent,
4598                                    tree_dir, tree_subdir_new, type);
4599   }
4600
4601   // set draw deactivation mask to previous value
4602   SetDrawDeactivationMask(draw_deactivation_mask);
4603
4604   // get first node of level or artwork info tree
4605   TreeInfo **tree_node_first = TREE_FIRST_NODE_PTR(type);
4606
4607   // get tree info node of newly added level or artwork set
4608   TreeInfo *tree_node_new = getTreeInfoFromIdentifier(*tree_node_first,
4609                                                       tree_subdir_new);
4610
4611   // if not found, check if added node is level group or artwork group
4612   if (tree_node_new == NULL)
4613     tree_node_new = getTreeInfoFromIdentifierExt(*tree_node_first,
4614                                                  tree_subdir_new,
4615                                                  TREE_NODE_TYPE_GROUP);
4616
4617   if (tree_node_new == NULL)            // should not happen
4618     return FALSE;
4619
4620   // correct top link and parent node link of newly created tree node
4621   tree_node_new->node_top    = tree_node_old->node_top;
4622   tree_node_new->node_parent = tree_node_old->node_parent;
4623
4624   // sort tree info to adjust position of newly added tree set
4625   sortTreeInfo(tree_node_first);
4626
4627   return TRUE;
4628 }
4629
4630 void AddTreeSetToTreeInfo(TreeInfo *tree_node, char *tree_dir,
4631                           char *tree_subdir_new, int type)
4632 {
4633   if (!AddTreeSetToTreeInfoExt(tree_node, tree_dir, tree_subdir_new, type))
4634     Fail("internal tree info structure corrupted -- aborting");
4635 }
4636
4637 void AddUserLevelSetToLevelInfo(char *level_subdir_new)
4638 {
4639   AddTreeSetToTreeInfo(NULL, NULL, level_subdir_new, TREE_TYPE_LEVEL_DIR);
4640 }
4641
4642 char *getArtworkIdentifierForUserLevelSet(int type)
4643 {
4644   char *classic_artwork_set = getClassicArtworkSet(type);
4645
4646   // check for custom artwork configured in "levelinfo.conf"
4647   char *leveldir_artwork_set =
4648     *LEVELDIR_ARTWORK_SET_PTR(leveldir_current, type);
4649   boolean has_leveldir_artwork_set =
4650     (leveldir_artwork_set != NULL && !strEqual(leveldir_artwork_set,
4651                                                classic_artwork_set));
4652
4653   // check for custom artwork in sub-directory "graphics" etc.
4654   TreeInfo *artwork_first_node = ARTWORK_FIRST_NODE(artwork, type);
4655   char *leveldir_identifier = leveldir_current->identifier;
4656   boolean has_artwork_subdir =
4657     (getTreeInfoFromIdentifier(artwork_first_node,
4658                                leveldir_identifier) != NULL);
4659
4660   return (has_leveldir_artwork_set ? leveldir_artwork_set :
4661           has_artwork_subdir       ? leveldir_identifier :
4662           classic_artwork_set);
4663 }
4664
4665 TreeInfo *getArtworkTreeInfoForUserLevelSet(int type)
4666 {
4667   char *artwork_set = getArtworkIdentifierForUserLevelSet(type);
4668   TreeInfo *artwork_first_node = ARTWORK_FIRST_NODE(artwork, type);
4669   TreeInfo *ti = getTreeInfoFromIdentifier(artwork_first_node, artwork_set);
4670
4671   if (ti == NULL)
4672   {
4673     ti = getTreeInfoFromIdentifier(artwork_first_node,
4674                                    ARTWORK_DEFAULT_SUBDIR(type));
4675     if (ti == NULL)
4676       Fail("cannot find default graphics -- should not happen");
4677   }
4678
4679   return ti;
4680 }
4681
4682 boolean checkIfCustomArtworkExistsForCurrentLevelSet(void)
4683 {
4684   char *graphics_set =
4685     getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_GRAPHICS);
4686   char *sounds_set =
4687     getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_SOUNDS);
4688   char *music_set =
4689     getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_MUSIC);
4690
4691   return (!strEqual(graphics_set, GFX_CLASSIC_SUBDIR) ||
4692           !strEqual(sounds_set,   SND_CLASSIC_SUBDIR) ||
4693           !strEqual(music_set,    MUS_CLASSIC_SUBDIR));
4694 }
4695
4696 boolean UpdateUserLevelSet(char *level_subdir, char *level_name,
4697                            char *level_author, int num_levels)
4698 {
4699   char *filename = getPath2(getUserLevelDir(level_subdir), LEVELINFO_FILENAME);
4700   char *filename_tmp = getStringCat2(filename, ".tmp");
4701   FILE *file = NULL;
4702   FILE *file_tmp = NULL;
4703   char line[MAX_LINE_LEN];
4704   boolean success = FALSE;
4705   LevelDirTree *leveldir = getTreeInfoFromIdentifier(leveldir_first,
4706                                                      level_subdir);
4707   // update values in level directory tree
4708
4709   if (level_name != NULL)
4710     setString(&leveldir->name, level_name);
4711
4712   if (level_author != NULL)
4713     setString(&leveldir->author, level_author);
4714
4715   if (num_levels != -1)
4716     leveldir->levels = num_levels;
4717
4718   // update values that depend on other values
4719
4720   setString(&leveldir->name_sorting, leveldir->name);
4721
4722   leveldir->last_level = leveldir->first_level + leveldir->levels - 1;
4723
4724   // sort order of level sets may have changed
4725   sortTreeInfo(&leveldir_first);
4726
4727   if ((file     = fopen(filename,     MODE_READ)) &&
4728       (file_tmp = fopen(filename_tmp, MODE_WRITE)))
4729   {
4730     while (fgets(line, MAX_LINE_LEN, file))
4731     {
4732       if (strPrefix(line, "name:") && level_name != NULL)
4733         fprintf(file_tmp, "%-32s%s\n", "name:", level_name);
4734       else if (strPrefix(line, "author:") && level_author != NULL)
4735         fprintf(file_tmp, "%-32s%s\n", "author:", level_author);
4736       else if (strPrefix(line, "levels:") && num_levels != -1)
4737         fprintf(file_tmp, "%-32s%d\n", "levels:", num_levels);
4738       else
4739         fputs(line, file_tmp);
4740     }
4741
4742     success = TRUE;
4743   }
4744
4745   if (file)
4746     fclose(file);
4747
4748   if (file_tmp)
4749     fclose(file_tmp);
4750
4751   if (success)
4752     success = (rename(filename_tmp, filename) == 0);
4753
4754   free(filename);
4755   free(filename_tmp);
4756
4757   return success;
4758 }
4759
4760 boolean CreateUserLevelSet(char *level_subdir, char *level_name,
4761                            char *level_author, int num_levels,
4762                            boolean use_artwork_set)
4763 {
4764   LevelDirTree *level_info;
4765   char *filename;
4766   FILE *file;
4767   int i;
4768
4769   // create user level sub-directory, if needed
4770   createDirectory(getUserLevelDir(level_subdir), "user level");
4771
4772   filename = getPath2(getUserLevelDir(level_subdir), LEVELINFO_FILENAME);
4773
4774   if (!(file = fopen(filename, MODE_WRITE)))
4775   {
4776     Warn("cannot write level info file '%s'", filename);
4777
4778     free(filename);
4779
4780     return FALSE;
4781   }
4782
4783   level_info = newTreeInfo();
4784
4785   // always start with reliable default values
4786   setTreeInfoToDefaults(level_info, TREE_TYPE_LEVEL_DIR);
4787
4788   setString(&level_info->name, level_name);
4789   setString(&level_info->author, level_author);
4790   level_info->levels = num_levels;
4791   level_info->first_level = 1;
4792   level_info->sort_priority = LEVELCLASS_PRIVATE_START;
4793   level_info->readonly = FALSE;
4794
4795   if (use_artwork_set)
4796   {
4797     level_info->graphics_set =
4798       getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_GRAPHICS));
4799     level_info->sounds_set =
4800       getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_SOUNDS));
4801     level_info->music_set =
4802       getStringCopy(getArtworkIdentifierForUserLevelSet(ARTWORK_TYPE_MUSIC));
4803   }
4804
4805   token_value_position = TOKEN_VALUE_POSITION_SHORT;
4806
4807   fprintFileHeader(file, LEVELINFO_FILENAME);
4808
4809   ldi = *level_info;
4810   for (i = 0; i < NUM_LEVELINFO_TOKENS; i++)
4811   {
4812     if (i == LEVELINFO_TOKEN_NAME ||
4813         i == LEVELINFO_TOKEN_AUTHOR ||
4814         i == LEVELINFO_TOKEN_LEVELS ||
4815         i == LEVELINFO_TOKEN_FIRST_LEVEL ||
4816         i == LEVELINFO_TOKEN_SORT_PRIORITY ||
4817         i == LEVELINFO_TOKEN_READONLY ||
4818         (use_artwork_set && (i == LEVELINFO_TOKEN_GRAPHICS_SET ||
4819                              i == LEVELINFO_TOKEN_SOUNDS_SET ||
4820                              i == LEVELINFO_TOKEN_MUSIC_SET)))
4821       fprintf(file, "%s\n", getSetupLine(levelinfo_tokens, "", i));
4822
4823     // just to make things nicer :)
4824     if (i == LEVELINFO_TOKEN_AUTHOR ||
4825         i == LEVELINFO_TOKEN_FIRST_LEVEL ||
4826         (use_artwork_set && i == LEVELINFO_TOKEN_READONLY))
4827       fprintf(file, "\n");
4828   }
4829
4830   token_value_position = TOKEN_VALUE_POSITION_DEFAULT;
4831
4832   fclose(file);
4833
4834   SetFilePermissions(filename, PERMS_PRIVATE);
4835
4836   freeTreeInfo(level_info);
4837   free(filename);
4838
4839   return TRUE;
4840 }
4841
4842 static void SaveUserLevelInfo(void)
4843 {
4844   CreateUserLevelSet(getLoginName(), getLoginName(), getRealName(), 100, FALSE);
4845 }
4846
4847 char *getSetupValue(int type, void *value)
4848 {
4849   static char value_string[MAX_LINE_LEN];
4850
4851   if (value == NULL)
4852     return NULL;
4853
4854   switch (type)
4855   {
4856     case TYPE_BOOLEAN:
4857       strcpy(value_string, (*(boolean *)value ? "true" : "false"));
4858       break;
4859
4860     case TYPE_SWITCH:
4861       strcpy(value_string, (*(boolean *)value ? "on" : "off"));
4862       break;
4863
4864     case TYPE_SWITCH_3_STATES:
4865       strcpy(value_string, (*(int *)value == MODE_AUTO  ? "auto" :
4866                             *(int *)value == FALSE ? "off" : "on"));
4867       break;
4868
4869     case TYPE_YES_NO:
4870       strcpy(value_string, (*(boolean *)value ? "yes" : "no"));
4871       break;
4872
4873     case TYPE_YES_NO_AUTO:
4874       strcpy(value_string, (*(int *)value == MODE_AUTO  ? "auto" :
4875                             *(int *)value == FALSE ? "no" : "yes"));
4876       break;
4877
4878     case TYPE_ECS_AGA:
4879       strcpy(value_string, (*(boolean *)value ? "AGA" : "ECS"));
4880       break;
4881
4882     case TYPE_KEY:
4883       strcpy(value_string, getKeyNameFromKey(*(Key *)value));
4884       break;
4885
4886     case TYPE_KEY_X11:
4887       strcpy(value_string, getX11KeyNameFromKey(*(Key *)value));
4888       break;
4889
4890     case TYPE_INTEGER:
4891       sprintf(value_string, "%d", *(int *)value);
4892       break;
4893
4894     case TYPE_STRING:
4895       if (*(char **)value == NULL)
4896         return NULL;
4897
4898       strcpy(value_string, *(char **)value);
4899       break;
4900
4901     case TYPE_PLAYER:
4902       sprintf(value_string, "player_%d", *(int *)value + 1);
4903       break;
4904
4905     default:
4906       value_string[0] = '\0';
4907       break;
4908   }
4909
4910   if (type & TYPE_GHOSTED)
4911     strcpy(value_string, "n/a");
4912
4913   return value_string;
4914 }
4915
4916 char *getSetupLine(struct TokenInfo *token_info, char *prefix, int token_nr)
4917 {
4918   int i;
4919   char *line;
4920   static char token_string[MAX_LINE_LEN];
4921   int token_type = token_info[token_nr].type;
4922   void *setup_value = token_info[token_nr].value;
4923   char *token_text = token_info[token_nr].text;
4924   char *value_string = getSetupValue(token_type, setup_value);
4925
4926   // build complete token string
4927   sprintf(token_string, "%s%s", prefix, token_text);
4928
4929   // build setup entry line
4930   line = getFormattedSetupEntry(token_string, value_string);
4931
4932   if (token_type == TYPE_KEY_X11)
4933   {
4934     Key key = *(Key *)setup_value;
4935     char *keyname = getKeyNameFromKey(key);
4936
4937     // add comment, if useful
4938     if (!strEqual(keyname, "(undefined)") &&
4939         !strEqual(keyname, "(unknown)"))
4940     {
4941       // add at least one whitespace
4942       strcat(line, " ");
4943       for (i = strlen(line); i < token_comment_position; i++)
4944         strcat(line, " ");
4945
4946       strcat(line, "# ");
4947       strcat(line, keyname);
4948     }
4949   }
4950
4951   return line;
4952 }
4953
4954 static void InitLastPlayedLevels_ParentNode(void)
4955 {
4956   LevelDirTree **leveldir_top = &leveldir_first->node_group->next;
4957   LevelDirTree *leveldir_new = NULL;
4958
4959   // check if parent node for last played levels already exists
4960   if (strEqual((*leveldir_top)->identifier, TOKEN_STR_LAST_LEVEL_SERIES))
4961     return;
4962
4963   leveldir_new = newTreeInfo();
4964
4965   setTreeInfoToDefaultsFromParent(leveldir_new, leveldir_first);
4966
4967   leveldir_new->level_group = TRUE;
4968   leveldir_new->sort_priority = LEVELCLASS_LAST_PLAYED_LEVEL;
4969
4970   setString(&leveldir_new->identifier, TOKEN_STR_LAST_LEVEL_SERIES);
4971   setString(&leveldir_new->name, "<< (last played level sets)");
4972   setString(&leveldir_new->name_sorting, leveldir_new->name);
4973
4974   pushTreeInfo(leveldir_top, leveldir_new);
4975
4976   // create node to link back to current level directory
4977   createParentTreeInfoNode(leveldir_new);
4978 }
4979
4980 void UpdateLastPlayedLevels_TreeInfo(void)
4981 {
4982   char **last_level_series = setup.level_setup.last_level_series;
4983   LevelDirTree *leveldir_last;
4984   TreeInfo **node_new = NULL;
4985   int i;
4986
4987   if (last_level_series[0] == NULL)
4988     return;
4989
4990   InitLastPlayedLevels_ParentNode();
4991
4992   leveldir_last = getTreeInfoFromIdentifierExt(leveldir_first,
4993                                                TOKEN_STR_LAST_LEVEL_SERIES,
4994                                                TREE_NODE_TYPE_GROUP);
4995   if (leveldir_last == NULL)
4996     return;
4997
4998   node_new = &leveldir_last->node_group->next;
4999
5000   freeTreeInfo(*node_new);
5001
5002   *node_new = NULL;
5003
5004   for (i = 0; last_level_series[i] != NULL; i++)
5005   {
5006     LevelDirTree *node_last = getTreeInfoFromIdentifier(leveldir_first,
5007                                                         last_level_series[i]);
5008     if (node_last == NULL)
5009       continue;
5010
5011     *node_new = getTreeInfoCopy(node_last);     // copy complete node
5012
5013     (*node_new)->node_top = &leveldir_first;    // correct top node link
5014     (*node_new)->node_parent = leveldir_last;   // correct parent node link
5015
5016     (*node_new)->is_copy = TRUE;                // mark entry as node copy
5017
5018     (*node_new)->node_group = NULL;
5019     (*node_new)->next = NULL;
5020
5021     (*node_new)->cl_first = -1;                 // force setting tree cursor
5022
5023     node_new = &((*node_new)->next);
5024   }
5025 }
5026
5027 static void UpdateLastPlayedLevels_List(void)
5028 {
5029   char **last_level_series = setup.level_setup.last_level_series;
5030   int pos = MAX_LEVELDIR_HISTORY - 1;
5031   int i;
5032
5033   // search for potentially already existing entry in list of level sets
5034   for (i = 0; last_level_series[i] != NULL; i++)
5035     if (strEqual(last_level_series[i], leveldir_current->identifier))
5036       pos = i;
5037
5038   // move list of level sets one entry down (using potentially free entry)
5039   for (i = pos; i > 0; i--)
5040     setString(&last_level_series[i], last_level_series[i - 1]);
5041
5042   // put last played level set at top position
5043   setString(&last_level_series[0], leveldir_current->identifier);
5044 }
5045
5046 #define LAST_PLAYED_MODE_SET                    1
5047 #define LAST_PLAYED_MODE_SET_FORCED             2
5048 #define LAST_PLAYED_MODE_GET                    3
5049
5050 static TreeInfo *StoreOrRestoreLastPlayedLevels(TreeInfo *node, int mode)
5051 {
5052   static char *identifier = NULL;
5053
5054   if (mode == LAST_PLAYED_MODE_SET)
5055   {
5056     setString(&identifier, (node && node->is_copy ? node->identifier : NULL));
5057   }
5058   else if (mode == LAST_PLAYED_MODE_SET_FORCED)
5059   {
5060     setString(&identifier, (node ? node->identifier : NULL));
5061   }
5062   else if (mode == LAST_PLAYED_MODE_GET)
5063   {
5064     TreeInfo *node_new = getTreeInfoFromIdentifierExt(leveldir_first,
5065                                                       identifier,
5066                                                       TREE_NODE_TYPE_COPY);
5067     return (node_new != NULL ? node_new : node);
5068   }
5069
5070   return NULL;          // not used
5071 }
5072
5073 void StoreLastPlayedLevels(TreeInfo *node)
5074 {
5075   StoreOrRestoreLastPlayedLevels(node, LAST_PLAYED_MODE_SET);
5076 }
5077
5078 void ForcedStoreLastPlayedLevels(TreeInfo *node)
5079 {
5080   StoreOrRestoreLastPlayedLevels(node, LAST_PLAYED_MODE_SET_FORCED);
5081 }
5082
5083 void RestoreLastPlayedLevels(TreeInfo **node)
5084 {
5085   *node = StoreOrRestoreLastPlayedLevels(*node, LAST_PLAYED_MODE_GET);
5086 }
5087
5088 boolean CheckLastPlayedLevels(void)
5089 {
5090   return (StoreOrRestoreLastPlayedLevels(NULL, LAST_PLAYED_MODE_GET) != NULL);
5091 }
5092
5093 void LoadLevelSetup_LastSeries(void)
5094 {
5095   // --------------------------------------------------------------------------
5096   // ~/.<program>/levelsetup.conf
5097   // --------------------------------------------------------------------------
5098
5099   char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
5100   SetupFileHash *level_setup_hash = NULL;
5101   int pos = 0;
5102   int i;
5103
5104   // always start with reliable default values
5105   leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
5106
5107   // start with empty history of last played level sets
5108   setString(&setup.level_setup.last_level_series[0], NULL);
5109
5110   if (!strEqual(DEFAULT_LEVELSET, UNDEFINED_LEVELSET))
5111   {
5112     leveldir_current = getTreeInfoFromIdentifier(leveldir_first,
5113                                                  DEFAULT_LEVELSET);
5114     if (leveldir_current == NULL)
5115       leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
5116   }
5117
5118   if ((level_setup_hash = loadSetupFileHash(filename)))
5119   {
5120     char *last_level_series =
5121       getHashEntry(level_setup_hash, TOKEN_STR_LAST_LEVEL_SERIES);
5122
5123     leveldir_current = getTreeInfoFromIdentifier(leveldir_first,
5124                                                  last_level_series);
5125     if (leveldir_current == NULL)
5126       leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
5127
5128     char *last_played_menu_used =
5129       getHashEntry(level_setup_hash, TOKEN_STR_LAST_PLAYED_MENU_USED);
5130
5131     // store if last level set was selected from "last played" menu
5132     if (strEqual(last_played_menu_used, "true"))
5133       ForcedStoreLastPlayedLevels(leveldir_current);
5134
5135     for (i = 0; i < MAX_LEVELDIR_HISTORY; i++)
5136     {
5137       char token[strlen(TOKEN_STR_LAST_LEVEL_SERIES) + 10];
5138       LevelDirTree *leveldir_last;
5139
5140       sprintf(token, "%s.%03d", TOKEN_STR_LAST_LEVEL_SERIES, i);
5141
5142       last_level_series = getHashEntry(level_setup_hash, token);
5143
5144       leveldir_last = getTreeInfoFromIdentifier(leveldir_first,
5145                                                 last_level_series);
5146       if (leveldir_last != NULL)
5147         setString(&setup.level_setup.last_level_series[pos++],
5148                   last_level_series);
5149     }
5150
5151     setString(&setup.level_setup.last_level_series[pos], NULL);
5152
5153     freeSetupFileHash(level_setup_hash);
5154   }
5155   else
5156   {
5157     Debug("setup", "using default setup values");
5158   }
5159
5160   free(filename);
5161 }
5162
5163 static void SaveLevelSetup_LastSeries_Ext(boolean deactivate_last_level_series)
5164 {
5165   // --------------------------------------------------------------------------
5166   // ~/.<program>/levelsetup.conf
5167   // --------------------------------------------------------------------------
5168
5169   // check if the current level directory structure is available at this point
5170   if (leveldir_current == NULL)
5171     return;
5172
5173   char **last_level_series = setup.level_setup.last_level_series;
5174   char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
5175   FILE *file;
5176   int i;
5177
5178   InitUserDataDirectory();
5179
5180   UpdateLastPlayedLevels_List();
5181
5182   if (!(file = fopen(filename, MODE_WRITE)))
5183   {
5184     Warn("cannot write setup file '%s'", filename);
5185
5186     free(filename);
5187
5188     return;
5189   }
5190
5191   fprintFileHeader(file, LEVELSETUP_FILENAME);
5192
5193   if (deactivate_last_level_series)
5194     fprintf(file, "# %s\n# ", "the following level set may have caused a problem and was deactivated");
5195
5196   fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_LAST_LEVEL_SERIES,
5197                                                  leveldir_current->identifier));
5198
5199   // store if last level set was selected from "last played" menu
5200   boolean last_played_menu_used = CheckLastPlayedLevels();
5201   char *setup_value = getSetupValue(TYPE_BOOLEAN, &last_played_menu_used);
5202
5203   fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_LAST_PLAYED_MENU_USED,
5204                                                  setup_value));
5205
5206   for (i = 0; last_level_series[i] != NULL; i++)
5207   {
5208     char token[strlen(TOKEN_STR_LAST_LEVEL_SERIES) + 1 + 10 + 1];
5209
5210     sprintf(token, "%s.%03d", TOKEN_STR_LAST_LEVEL_SERIES, i);
5211
5212     fprintf(file, "%s\n", getFormattedSetupEntry(token, last_level_series[i]));
5213   }
5214
5215   fclose(file);
5216
5217   SetFilePermissions(filename, PERMS_PRIVATE);
5218
5219   free(filename);
5220 }
5221
5222 void SaveLevelSetup_LastSeries(void)
5223 {
5224   SaveLevelSetup_LastSeries_Ext(FALSE);
5225 }
5226
5227 void SaveLevelSetup_LastSeries_Deactivate(void)
5228 {
5229   SaveLevelSetup_LastSeries_Ext(TRUE);
5230 }
5231
5232 static void checkSeriesInfo(void)
5233 {
5234   static char *level_directory = NULL;
5235   Directory *dir;
5236 #if 0
5237   DirectoryEntry *dir_entry;
5238 #endif
5239
5240   checked_free(level_directory);
5241
5242   // check for more levels besides the 'levels' field of 'levelinfo.conf'
5243
5244   level_directory = getPath2((leveldir_current->in_user_dir ?
5245                               getUserLevelDir(NULL) :
5246                               options.level_directory),
5247                              leveldir_current->fullpath);
5248
5249   if ((dir = openDirectory(level_directory)) == NULL)
5250   {
5251     Warn("cannot read level directory '%s'", level_directory);
5252
5253     return;
5254   }
5255
5256 #if 0
5257   while ((dir_entry = readDirectory(dir)) != NULL)      // loop all entries
5258   {
5259     if (strlen(dir_entry->basename) > 4 &&
5260         dir_entry->basename[3] == '.' &&
5261         strEqual(&dir_entry->basename[4], LEVELFILE_EXTENSION))
5262     {
5263       char levelnum_str[4];
5264       int levelnum_value;
5265
5266       strncpy(levelnum_str, dir_entry->basename, 3);
5267       levelnum_str[3] = '\0';
5268
5269       levelnum_value = atoi(levelnum_str);
5270
5271       if (levelnum_value < leveldir_current->first_level)
5272       {
5273         Warn("additional level %d found", levelnum_value);
5274
5275         leveldir_current->first_level = levelnum_value;
5276       }
5277       else if (levelnum_value > leveldir_current->last_level)
5278       {
5279         Warn("additional level %d found", levelnum_value);
5280
5281         leveldir_current->last_level = levelnum_value;
5282       }
5283     }
5284   }
5285 #endif
5286
5287   closeDirectory(dir);
5288 }
5289
5290 void LoadLevelSetup_SeriesInfo(void)
5291 {
5292   char *filename;
5293   SetupFileHash *level_setup_hash = NULL;
5294   char *level_subdir = leveldir_current->subdir;
5295   int i;
5296
5297   // always start with reliable default values
5298   level_nr = leveldir_current->first_level;
5299
5300   for (i = 0; i < MAX_LEVELS; i++)
5301   {
5302     LevelStats_setPlayed(i, 0);
5303     LevelStats_setSolved(i, 0);
5304   }
5305
5306   checkSeriesInfo();
5307
5308   // --------------------------------------------------------------------------
5309   // ~/.<program>/levelsetup/<level series>/levelsetup.conf
5310   // --------------------------------------------------------------------------
5311
5312   level_subdir = leveldir_current->subdir;
5313
5314   filename = getPath2(getLevelSetupDir(level_subdir), LEVELSETUP_FILENAME);
5315
5316   if ((level_setup_hash = loadSetupFileHash(filename)))
5317   {
5318     char *token_value;
5319
5320     // get last played level in this level set
5321
5322     token_value = getHashEntry(level_setup_hash, TOKEN_STR_LAST_PLAYED_LEVEL);
5323
5324     if (token_value)
5325     {
5326       level_nr = atoi(token_value);
5327
5328       if (level_nr < leveldir_current->first_level)
5329         level_nr = leveldir_current->first_level;
5330       if (level_nr > leveldir_current->last_level)
5331         level_nr = leveldir_current->last_level;
5332     }
5333
5334     // get handicap level in this level set
5335
5336     token_value = getHashEntry(level_setup_hash, TOKEN_STR_HANDICAP_LEVEL);
5337
5338     if (token_value)
5339     {
5340       int level_nr = atoi(token_value);
5341
5342       if (level_nr < leveldir_current->first_level)
5343         level_nr = leveldir_current->first_level;
5344       if (level_nr > leveldir_current->last_level + 1)
5345         level_nr = leveldir_current->last_level;
5346
5347       if (leveldir_current->user_defined || !leveldir_current->handicap)
5348         level_nr = leveldir_current->last_level;
5349
5350       leveldir_current->handicap_level = level_nr;
5351     }
5352
5353     // get number of played and solved levels in this level set
5354
5355     BEGIN_HASH_ITERATION(level_setup_hash, itr)
5356     {
5357       char *token = HASH_ITERATION_TOKEN(itr);
5358       char *value = HASH_ITERATION_VALUE(itr);
5359
5360       if (strlen(token) == 3 &&
5361           token[0] >= '0' && token[0] <= '9' &&
5362           token[1] >= '0' && token[1] <= '9' &&
5363           token[2] >= '0' && token[2] <= '9')
5364       {
5365         int level_nr = atoi(token);
5366
5367         if (value != NULL)
5368           LevelStats_setPlayed(level_nr, atoi(value));  // read 1st column
5369
5370         value = strchr(value, ' ');
5371
5372         if (value != NULL)
5373           LevelStats_setSolved(level_nr, atoi(value));  // read 2nd column
5374       }
5375     }
5376     END_HASH_ITERATION(hash, itr)
5377
5378     freeSetupFileHash(level_setup_hash);
5379   }
5380   else
5381   {
5382     Debug("setup", "using default setup values");
5383   }
5384
5385   free(filename);
5386 }
5387
5388 void SaveLevelSetup_SeriesInfo(void)
5389 {
5390   char *filename;
5391   char *level_subdir = leveldir_current->subdir;
5392   char *level_nr_str = int2str(level_nr, 0);
5393   char *handicap_level_str = int2str(leveldir_current->handicap_level, 0);
5394   FILE *file;
5395   int i;
5396
5397   // --------------------------------------------------------------------------
5398   // ~/.<program>/levelsetup/<level series>/levelsetup.conf
5399   // --------------------------------------------------------------------------
5400
5401   InitLevelSetupDirectory(level_subdir);
5402
5403   filename = getPath2(getLevelSetupDir(level_subdir), LEVELSETUP_FILENAME);
5404
5405   if (!(file = fopen(filename, MODE_WRITE)))
5406   {
5407     Warn("cannot write setup file '%s'", filename);
5408
5409     free(filename);
5410
5411     return;
5412   }
5413
5414   fprintFileHeader(file, LEVELSETUP_FILENAME);
5415
5416   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_LAST_PLAYED_LEVEL,
5417                                                level_nr_str));
5418   fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_HANDICAP_LEVEL,
5419                                                  handicap_level_str));
5420
5421   for (i = leveldir_current->first_level; i <= leveldir_current->last_level;
5422        i++)
5423   {
5424     if (LevelStats_getPlayed(i) > 0 ||
5425         LevelStats_getSolved(i) > 0)
5426     {
5427       char token[16];
5428       char value[16];
5429
5430       sprintf(token, "%03d", i);
5431       sprintf(value, "%d %d", LevelStats_getPlayed(i), LevelStats_getSolved(i));
5432
5433       fprintf(file, "%s\n", getFormattedSetupEntry(token, value));
5434     }
5435   }
5436
5437   fclose(file);
5438
5439   SetFilePermissions(filename, PERMS_PRIVATE);
5440
5441   free(filename);
5442 }
5443
5444 int LevelStats_getPlayed(int nr)
5445 {
5446   return (nr >= 0 && nr < MAX_LEVELS ? level_stats[nr].played : 0);
5447 }
5448
5449 int LevelStats_getSolved(int nr)
5450 {
5451   return (nr >= 0 && nr < MAX_LEVELS ? level_stats[nr].solved : 0);
5452 }
5453
5454 void LevelStats_setPlayed(int nr, int value)
5455 {
5456   if (nr >= 0 && nr < MAX_LEVELS)
5457     level_stats[nr].played = value;
5458 }
5459
5460 void LevelStats_setSolved(int nr, int value)
5461 {
5462   if (nr >= 0 && nr < MAX_LEVELS)
5463     level_stats[nr].solved = value;
5464 }
5465
5466 void LevelStats_incPlayed(int nr)
5467 {
5468   if (nr >= 0 && nr < MAX_LEVELS)
5469     level_stats[nr].played++;
5470 }
5471
5472 void LevelStats_incSolved(int nr)
5473 {
5474   if (nr >= 0 && nr < MAX_LEVELS)
5475     level_stats[nr].solved++;
5476 }
5477
5478 void LoadUserSetup(void)
5479 {
5480   // --------------------------------------------------------------------------
5481   // ~/.<program>/usersetup.conf
5482   // --------------------------------------------------------------------------
5483
5484   char *filename = getPath2(getMainUserGameDataDir(), USERSETUP_FILENAME);
5485   SetupFileHash *user_setup_hash = NULL;
5486
5487   // always start with reliable default values
5488   user.nr = 0;
5489
5490   if ((user_setup_hash = loadSetupFileHash(filename)))
5491   {
5492     char *token_value;
5493
5494     // get last selected user number
5495     token_value = getHashEntry(user_setup_hash, TOKEN_STR_LAST_USER);
5496
5497     if (token_value)
5498       user.nr = MIN(MAX(0, atoi(token_value)), MAX_PLAYER_NAMES - 1);
5499
5500     freeSetupFileHash(user_setup_hash);
5501   }
5502   else
5503   {
5504     Debug("setup", "using default setup values");
5505   }
5506
5507   free(filename);
5508 }
5509
5510 void SaveUserSetup(void)
5511 {
5512   // --------------------------------------------------------------------------
5513   // ~/.<program>/usersetup.conf
5514   // --------------------------------------------------------------------------
5515
5516   char *filename = getPath2(getMainUserGameDataDir(), USERSETUP_FILENAME);
5517   FILE *file;
5518
5519   InitMainUserDataDirectory();
5520
5521   if (!(file = fopen(filename, MODE_WRITE)))
5522   {
5523     Warn("cannot write setup file '%s'", filename);
5524
5525     free(filename);
5526
5527     return;
5528   }
5529
5530   fprintFileHeader(file, USERSETUP_FILENAME);
5531
5532   fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_LAST_USER,
5533                                                i_to_a(user.nr)));
5534   fclose(file);
5535
5536   SetFilePermissions(filename, PERMS_PRIVATE);
5537
5538   free(filename);
5539 }