X-Git-Url: https://git.artsoft.org/?a=blobdiff_plain;f=src%2Flibgame%2Fsetup.c;h=6f8ffaca24695f5a1d8795bb8ba7339f5b602a42;hb=b640b9d7647df4cbba0e530f6f4bcece384048e4;hp=fcc105bde246b029ee194a2a2429e433eef62747;hpb=e0e2697df0d0da483a91b1248c120aef6b3caf9b;p=rocksndiamonds.git diff --git a/src/libgame/setup.c b/src/libgame/setup.c index fcc105bd..6f8ffaca 100644 --- a/src/libgame/setup.c +++ b/src/libgame/setup.c @@ -11,8 +11,9 @@ * setup.c * ***********************************************************/ -#include +#include #include +#include #include #include @@ -20,27 +21,11 @@ #include "joystick.h" #include "text.h" #include "misc.h" +#include "hash.h" -/* file names and filename extensions */ -#if !defined(PLATFORM_MSDOS) -#define LEVELSETUP_DIRECTORY "levelsetup" -#define SETUP_FILENAME "setup.conf" -#define LEVELSETUP_FILENAME "levelsetup.conf" -#define LEVELINFO_FILENAME "levelinfo.conf" -#define LEVELFILE_EXTENSION "level" -#define TAPEFILE_EXTENSION "tape" -#define SCOREFILE_EXTENSION "score" -#else -#define LEVELSETUP_DIRECTORY "lvlsetup" -#define SETUP_FILENAME "setup.cnf" -#define LEVELSETUP_FILENAME "lvlsetup.cnf" -#define LEVELINFO_FILENAME "lvlinfo.cnf" -#define LEVELFILE_EXTENSION "lvl" -#define TAPEFILE_EXTENSION "tap" -#define SCOREFILE_EXTENSION "sco" -#endif #define NUM_LEVELCLASS_DESC 8 + static char *levelclass_desc[NUM_LEVELCLASS_DESC] = { "Tutorial Levels", @@ -53,36 +38,56 @@ static char *levelclass_desc[NUM_LEVELCLASS_DESC] = "DX Boulderdash" }; -#define LEVELCOLOR(n) (IS_LEVELCLASS_TUTORIAL(n) ? FC_BLUE : \ - IS_LEVELCLASS_CLASSICS(n) ? FC_RED : \ - IS_LEVELCLASS_BD(n) ? FC_GREEN : \ - IS_LEVELCLASS_EM(n) ? FC_YELLOW : \ - IS_LEVELCLASS_SP(n) ? FC_GREEN : \ - IS_LEVELCLASS_DX(n) ? FC_YELLOW : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? FC_GREEN : \ - IS_LEVELCLASS_USER(n) ? FC_RED : \ + +#define LEVELCOLOR(n) (IS_LEVELCLASS_TUTORIAL(n) ? FC_BLUE : \ + IS_LEVELCLASS_CLASSICS(n) ? FC_RED : \ + IS_LEVELCLASS_BD(n) ? FC_YELLOW : \ + IS_LEVELCLASS_EM(n) ? FC_YELLOW : \ + IS_LEVELCLASS_SP(n) ? FC_YELLOW : \ + IS_LEVELCLASS_DX(n) ? FC_YELLOW : \ + IS_LEVELCLASS_SB(n) ? FC_YELLOW : \ + IS_LEVELCLASS_CONTRIB(n) ? FC_GREEN : \ + IS_LEVELCLASS_PRIVATE(n) ? FC_RED : \ FC_BLUE) -#define LEVELSORTING(n) (IS_LEVELCLASS_TUTORIAL(n) ? 0 : \ - IS_LEVELCLASS_CLASSICS(n) ? 1 : \ - IS_LEVELCLASS_BD(n) ? 2 : \ - IS_LEVELCLASS_EM(n) ? 3 : \ - IS_LEVELCLASS_SP(n) ? 4 : \ - IS_LEVELCLASS_DX(n) ? 5 : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? 6 : \ - IS_LEVELCLASS_USER(n) ? 7 : \ +#define LEVELSORTING(n) (IS_LEVELCLASS_TUTORIAL(n) ? 0 : \ + IS_LEVELCLASS_CLASSICS(n) ? 1 : \ + IS_LEVELCLASS_BD(n) ? 2 : \ + IS_LEVELCLASS_EM(n) ? 3 : \ + IS_LEVELCLASS_SP(n) ? 4 : \ + IS_LEVELCLASS_DX(n) ? 5 : \ + IS_LEVELCLASS_SB(n) ? 6 : \ + IS_LEVELCLASS_CONTRIB(n) ? 7 : \ + IS_LEVELCLASS_PRIVATE(n) ? 8 : \ 9) -#define TOKEN_VALUE_POSITION 30 +#define ARTWORKCOLOR(n) (IS_ARTWORKCLASS_CLASSICS(n) ? FC_RED : \ + IS_ARTWORKCLASS_CONTRIB(n) ? FC_GREEN : \ + IS_ARTWORKCLASS_PRIVATE(n) ? FC_RED : \ + IS_ARTWORKCLASS_LEVEL(n) ? FC_YELLOW : \ + FC_BLUE) + +#define ARTWORKSORTING(n) (IS_ARTWORKCLASS_CLASSICS(n) ? 0 : \ + IS_ARTWORKCLASS_LEVEL(n) ? 1 : \ + IS_ARTWORKCLASS_CONTRIB(n) ? 2 : \ + IS_ARTWORKCLASS_PRIVATE(n) ? 3 : \ + 9) -#define MAX_COOKIE_LEN 256 +#define TOKEN_VALUE_POSITION_SHORT 32 +#define TOKEN_VALUE_POSITION_DEFAULT 40 +#define TOKEN_COMMENT_POSITION_DEFAULT 60 + +#define MAX_COOKIE_LEN 256 + +static int token_value_position = TOKEN_VALUE_POSITION_DEFAULT; +static int token_comment_position = TOKEN_COMMENT_POSITION_DEFAULT; /* ------------------------------------------------------------------------- */ /* file functions */ /* ------------------------------------------------------------------------- */ -char *getLevelClassDescription(struct LevelDirInfo *ldi) +static char *getLevelClassDescription(TreeInfo *ldi) { int position = ldi->sort_priority / 100; @@ -98,10 +103,9 @@ static char *getUserLevelDir(char *level_subdir) char *data_dir = getUserDataDir(); char *userlevel_subdir = LEVELS_DIRECTORY; - if (userlevel_dir) - free(userlevel_dir); + checked_free(userlevel_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) userlevel_dir = getPath3(data_dir, userlevel_subdir, level_subdir); else userlevel_dir = getPath2(data_dir, userlevel_subdir); @@ -109,33 +113,15 @@ static char *getUserLevelDir(char *level_subdir) return userlevel_dir; } -static char *getTapeDir(char *level_subdir) -{ - static char *tape_dir = NULL; - char *data_dir = getUserDataDir(); - char *tape_subdir = TAPES_DIRECTORY; - - if (tape_dir) - free(tape_dir); - - if (strlen(level_subdir) > 0) - tape_dir = getPath3(data_dir, tape_subdir, level_subdir); - else - tape_dir = getPath2(data_dir, tape_subdir); - - return tape_dir; -} - static char *getScoreDir(char *level_subdir) { static char *score_dir = NULL; - char *data_dir = options.rw_base_directory; + char *data_dir = getCommonDataDir(); char *score_subdir = SCORES_DIRECTORY; - if (score_dir) - free(score_dir); + checked_free(score_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) score_dir = getPath3(data_dir, score_subdir, level_subdir); else score_dir = getPath2(data_dir, score_subdir); @@ -149,10 +135,9 @@ static char *getLevelSetupDir(char *level_subdir) char *data_dir = getUserDataDir(); char *levelsetup_subdir = LEVELSETUP_DIRECTORY; - if (levelsetup_dir) - free(levelsetup_dir); + checked_free(levelsetup_dir); - if (strlen(level_subdir) > 0) + if (level_subdir != NULL) levelsetup_dir = getPath3(data_dir, levelsetup_subdir, level_subdir); else levelsetup_dir = getPath2(data_dir, levelsetup_subdir); @@ -160,990 +145,2307 @@ static char *getLevelSetupDir(char *level_subdir) return levelsetup_dir; } -char *getLevelFilename(int nr) +static char *getLevelDirFromTreeInfo(TreeInfo *node) { - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; + static char *level_dir = NULL; - if (filename != NULL) - free(filename); + if (node == NULL) + return options.level_directory; - sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION); - filename = getPath3((leveldir_current->user_defined ? - getUserLevelDir("") : - options.level_directory), - leveldir_current->fullpath, - basename); + checked_free(level_dir); - return filename; + level_dir = getPath2((node->in_user_dir ? getUserLevelDir(NULL) : + options.level_directory), node->fullpath); + + return level_dir; } -char *getTapeFilename(int nr) +char *getCurrentLevelDir() { - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; + return getLevelDirFromTreeInfo(leveldir_current); +} - if (filename != NULL) - free(filename); +static char *getTapeDir(char *level_subdir) +{ + static char *tape_dir = NULL; + char *data_dir = getUserDataDir(); + char *tape_subdir = TAPES_DIRECTORY; - sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); - filename = getPath2(getTapeDir(leveldir_current->filename), basename); + checked_free(tape_dir); - return filename; + if (level_subdir != NULL) + tape_dir = getPath3(data_dir, tape_subdir, level_subdir); + else + tape_dir = getPath2(data_dir, tape_subdir); + + return tape_dir; } -char *getScoreFilename(int nr) +static char *getSolutionTapeDir() { - static char *filename = NULL; - char basename[MAX_FILENAME_LEN]; + static char *tape_dir = NULL; + char *data_dir = getCurrentLevelDir(); + char *tape_subdir = TAPES_DIRECTORY; - if (filename != NULL) - free(filename); + checked_free(tape_dir); - sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION); - filename = getPath2(getScoreDir(leveldir_current->filename), basename); + tape_dir = getPath2(data_dir, tape_subdir); - return filename; + return tape_dir; } -char *getSetupFilename() +static char *getDefaultGraphicsDir(char *graphics_subdir) { - static char *filename = NULL; + static char *graphics_dir = NULL; - if (filename != NULL) - free(filename); + if (graphics_subdir == NULL) + return options.graphics_directory; - filename = getPath2(getSetupDir(), SETUP_FILENAME); + checked_free(graphics_dir); - return filename; + graphics_dir = getPath2(options.graphics_directory, graphics_subdir); + + return graphics_dir; } -void InitTapeDirectory(char *level_subdir) +static char *getDefaultSoundsDir(char *sounds_subdir) { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getTapeDir(""), "main tape", PERMS_PRIVATE); - createDirectory(getTapeDir(level_subdir), "level tape", PERMS_PRIVATE); + static char *sounds_dir = NULL; + + if (sounds_subdir == NULL) + return options.sounds_directory; + + checked_free(sounds_dir); + + sounds_dir = getPath2(options.sounds_directory, sounds_subdir); + + return sounds_dir; } -void InitScoreDirectory(char *level_subdir) +static char *getDefaultMusicDir(char *music_subdir) { - createDirectory(getScoreDir(""), "main score", PERMS_PUBLIC); - createDirectory(getScoreDir(level_subdir), "level score", PERMS_PUBLIC); -} + static char *music_dir = NULL; -static void SaveUserLevelInfo(); + if (music_subdir == NULL) + return options.music_directory; -void InitUserLevelDirectory(char *level_subdir) -{ - if (access(getUserLevelDir(level_subdir), F_OK) != 0) - { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getUserLevelDir(""), "main user level", PERMS_PRIVATE); - createDirectory(getUserLevelDir(level_subdir), "user level",PERMS_PRIVATE); + checked_free(music_dir); - SaveUserLevelInfo(); - } + music_dir = getPath2(options.music_directory, music_subdir); + + return music_dir; } -void InitLevelSetupDirectory(char *level_subdir) +static char *getDefaultArtworkSet(int type) { - createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); - createDirectory(getLevelSetupDir(""), "main level setup", PERMS_PRIVATE); - createDirectory(getLevelSetupDir(level_subdir), "level setup",PERMS_PRIVATE); + return (type == TREE_TYPE_GRAPHICS_DIR ? GFX_CLASSIC_SUBDIR : + type == TREE_TYPE_SOUNDS_DIR ? SND_CLASSIC_SUBDIR : + type == TREE_TYPE_MUSIC_DIR ? MUS_CLASSIC_SUBDIR : ""); } -void ReadChunk_VERS(FILE *file, int *file_version, int *game_version) +static char *getDefaultArtworkDir(int type) { - int file_version_major, file_version_minor, file_version_patch; - int game_version_major, game_version_minor, game_version_patch; - - file_version_major = fgetc(file); - file_version_minor = fgetc(file); - file_version_patch = fgetc(file); - fgetc(file); /* not used */ + return (type == TREE_TYPE_GRAPHICS_DIR ? + getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR) : + type == TREE_TYPE_SOUNDS_DIR ? + getDefaultSoundsDir(SND_CLASSIC_SUBDIR) : + type == TREE_TYPE_MUSIC_DIR ? + getDefaultMusicDir(MUS_CLASSIC_SUBDIR) : ""); +} - game_version_major = fgetc(file); - game_version_minor = fgetc(file); - game_version_patch = fgetc(file); - fgetc(file); /* not used */ +static char *getUserGraphicsDir() +{ + static char *usergraphics_dir = NULL; - *file_version = VERSION_IDENT(file_version_major, - file_version_minor, - file_version_patch); + if (usergraphics_dir == NULL) + usergraphics_dir = getPath2(getUserDataDir(), GRAPHICS_DIRECTORY); - *game_version = VERSION_IDENT(game_version_major, - game_version_minor, - game_version_patch); + return usergraphics_dir; } -void WriteChunk_VERS(FILE *file, int file_version, int game_version) +static char *getUserSoundsDir() { - int file_version_major = VERSION_MAJOR(file_version); - int file_version_minor = VERSION_MINOR(file_version); - int file_version_patch = VERSION_PATCH(file_version); - int game_version_major = VERSION_MAJOR(game_version); - int game_version_minor = VERSION_MINOR(game_version); - int game_version_patch = VERSION_PATCH(game_version); + static char *usersounds_dir = NULL; - fputc(file_version_major, file); - fputc(file_version_minor, file); - fputc(file_version_patch, file); - fputc(0, file); /* not used */ + if (usersounds_dir == NULL) + usersounds_dir = getPath2(getUserDataDir(), SOUNDS_DIRECTORY); - fputc(game_version_major, file); - fputc(game_version_minor, file); - fputc(game_version_patch, file); - fputc(0, file); /* not used */ + return usersounds_dir; } +static char *getUserMusicDir() +{ + static char *usermusic_dir = NULL; -/* ------------------------------------------------------------------------- */ -/* some functions to handle lists of level directories */ -/* ------------------------------------------------------------------------- */ + if (usermusic_dir == NULL) + usermusic_dir = getPath2(getUserDataDir(), MUSIC_DIRECTORY); -struct LevelDirInfo *newLevelDirInfo() -{ - return checked_calloc(sizeof(struct LevelDirInfo)); + return usermusic_dir; } -void pushLevelDirInfo(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_new) +static char *getSetupArtworkDir(TreeInfo *ti) { - node_new->next = *node_first; - *node_first = node_new; + static char *artwork_dir = NULL; + + checked_free(artwork_dir); + + artwork_dir = getPath2(ti->basepath, ti->fullpath); + + return artwork_dir; } -int numLevelDirInfo(struct LevelDirInfo *node) +char *setLevelArtworkDir(TreeInfo *ti) { - int num = 0; + char **artwork_path_ptr, **artwork_set_ptr; + TreeInfo *level_artwork; - while (node) + if (ti == NULL || leveldir_current == NULL) + return NULL; + + artwork_path_ptr = LEVELDIR_ARTWORK_PATH_PTR(leveldir_current, ti->type); + artwork_set_ptr = LEVELDIR_ARTWORK_SET_PTR( leveldir_current, ti->type); + + checked_free(*artwork_path_ptr); + + if ((level_artwork = getTreeInfoFromIdentifier(ti, *artwork_set_ptr))) + *artwork_path_ptr = getStringCopy(getSetupArtworkDir(level_artwork)); + else { - num++; - node = node->next; + /* No (or non-existing) artwork configured in "levelinfo.conf". This would + normally result in using the artwork configured in the setup menu. But + if an artwork subdirectory exists (which might contain custom artwork + or an artwork configuration file), this level artwork must be treated + as relative to the default "classic" artwork, not to the artwork that + is currently configured in the setup menu. */ + + char *dir = getPath2(getCurrentLevelDir(), ARTWORK_DIRECTORY(ti->type)); + + checked_free(*artwork_set_ptr); + + if (fileExists(dir)) + { + *artwork_path_ptr = getStringCopy(getDefaultArtworkDir(ti->type)); + *artwork_set_ptr = getStringCopy(getDefaultArtworkSet(ti->type)); + } + else + { + *artwork_path_ptr = getStringCopy(UNDEFINED_FILENAME); + *artwork_set_ptr = NULL; + } + + free(dir); } - return num; + return *artwork_set_ptr; } -boolean validLevelSeries(struct LevelDirInfo *node) +inline static char *getLevelArtworkSet(int type) { - return (node != NULL && !node->node_group && !node->parent_link); + if (leveldir_current == NULL) + return NULL; + + return LEVELDIR_ARTWORK_SET(leveldir_current, type); } -struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node) +inline static char *getLevelArtworkDir(int type) { - if (node == NULL) - { - if (leveldir_first) /* start with first level directory entry */ - return getFirstValidLevelSeries(leveldir_first); - else - return NULL; - } - else if (node->node_group) /* enter level group (step down into tree) */ - return getFirstValidLevelSeries(node->node_group); - else if (node->parent_link) /* skip start entry of level group */ - { - if (node->next) /* get first real level series entry */ - return getFirstValidLevelSeries(node->next); - else /* leave empty level group and go on */ - return getFirstValidLevelSeries(node->node_parent->next); - } - else /* this seems to be a regular level series */ - return node; + if (leveldir_current == NULL) + return UNDEFINED_FILENAME; + + return LEVELDIR_ARTWORK_PATH(leveldir_current, type); } -struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node) +char *getTapeFilename(int nr) { - if (node == NULL) - return NULL; + static char *filename = NULL; + char basename[MAX_FILENAME_LEN]; - if (node->node_parent == NULL) /* top level group */ - return leveldir_first; - else /* sub level group */ - return node->node_parent->node_group; + checked_free(filename); + + sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); + filename = getPath2(getTapeDir(leveldir_current->subdir), basename); + + return filename; } -int numLevelDirInfoInGroup(struct LevelDirInfo *node) +char *getSolutionTapeFilename(int nr) { - return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node)); + static char *filename = NULL; + char basename[MAX_FILENAME_LEN]; + + checked_free(filename); + + sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); + filename = getPath2(getSolutionTapeDir(), basename); + + return filename; } -int posLevelDirInfo(struct LevelDirInfo *node) +char *getScoreFilename(int nr) { - struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node); - int pos = 0; + static char *filename = NULL; + char basename[MAX_FILENAME_LEN]; - while (node_cmp) - { - if (node_cmp == node) - return pos; + checked_free(filename); - pos++; - node_cmp = node_cmp->next; - } + sprintf(basename, "%03d.%s", nr, SCOREFILE_EXTENSION); + filename = getPath2(getScoreDir(leveldir_current->subdir), basename); - return 0; + return filename; } -struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos) +char *getSetupFilename() { - struct LevelDirInfo *node_default = node; - int pos_cmp = 0; + static char *filename = NULL; - while (node) - { - if (pos_cmp == pos) - return node; + checked_free(filename); - pos_cmp++; - node = node->next; - } + filename = getPath2(getSetupDir(), SETUP_FILENAME); - return node_default; + return filename; } -struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node, - char *filename) +char *getEditorSetupFilename() { - if (filename == NULL) - return NULL; + static char *filename = NULL; - while (node) - { - if (node->node_group) - { - struct LevelDirInfo *node_group; + checked_free(filename); + filename = getPath2(getCurrentLevelDir(), EDITORSETUP_FILENAME); - node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename); + if (fileExists(filename)) + return filename; - if (node_group) - return node_group; - } - else if (!node->parent_link) - { - if (strcmp(filename, node->filename) == 0) - return node; - } + checked_free(filename); + filename = getPath2(getSetupDir(), EDITORSETUP_FILENAME); - node = node->next; - } + return filename; +} - return NULL; +char *getHelpAnimFilename() +{ + static char *filename = NULL; + + checked_free(filename); + + filename = getPath2(getCurrentLevelDir(), HELPANIM_FILENAME); + + return filename; } -struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename) +char *getHelpTextFilename() { - return getLevelDirInfoFromFilenameExt(leveldir_first, filename); + static char *filename = NULL; + + checked_free(filename); + + filename = getPath2(getCurrentLevelDir(), HELPTEXT_FILENAME); + + return filename; } -void dumpLevelDirInfo(struct LevelDirInfo *node, int depth) +char *getLevelSetInfoFilename() { + static char *filename = NULL; + char *basenames[] = + { + "README", + "README.TXT", + "README.txt", + "Readme", + "Readme.txt", + "readme", + "readme.txt", + + NULL + }; int i; - while (node) + for (i = 0; basenames[i] != NULL; i++) { - for (i=0; ifilename); - - if (node->node_group != NULL) - dumpLevelDirInfo(node->node_group, depth + 1); + checked_free(filename); + filename = getPath2(getCurrentLevelDir(), basenames[i]); - node = node->next; + if (fileExists(filename)) + return filename; } + + return NULL; } -void sortLevelDirInfo(struct LevelDirInfo **node_first, - int (*compare_function)(const void *, const void *)) +static char *getCorrectedArtworkBasename(char *basename) { - int num_nodes = numLevelDirInfo(*node_first); - struct LevelDirInfo **sort_array; - struct LevelDirInfo *node = *node_first; - int i = 0; + char *basename_corrected = basename; - if (num_nodes == 0) - return; +#if defined(PLATFORM_MSDOS) + if (program.filename_prefix != NULL) + { + int prefix_len = strlen(program.filename_prefix); - /* allocate array for sorting structure pointers */ - sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *)); + if (strncmp(basename, program.filename_prefix, prefix_len) == 0) + basename_corrected = &basename[prefix_len]; - /* writing structure pointers to sorting array */ - while (i < num_nodes && node) /* double boundary check... */ - { - sort_array[i] = node; + /* if corrected filename is still longer than standard MS-DOS filename + size (8 characters + 1 dot + 3 characters file extension), shorten + filename by writing file extension after 8th basename character */ + if (strlen(basename_corrected) > 8 + 1 + 3) + { + static char *msdos_filename = NULL; - i++; - node = node->next; + checked_free(msdos_filename); + + msdos_filename = getStringCopy(basename_corrected); + strncpy(&msdos_filename[8], &basename[strlen(basename) - (1+3)], 1+3 +1); + + basename_corrected = msdos_filename; + } } +#endif - /* sorting the structure pointers in the sorting array */ - qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *), - compare_function); + return basename_corrected; +} - /* update the linkage of list elements with the sorted node array */ - for (i=0; inext = sort_array[i + 1]; - sort_array[num_nodes - 1]->next = NULL; +char *getCustomImageFilename(char *basename) +{ + static char *filename = NULL; + boolean skip_setup_artwork = FALSE; - /* update the linkage of the main list anchor pointer */ - *node_first = sort_array[0]; + checked_free(filename); - free(sort_array); + basename = getCorrectedArtworkBasename(basename); - /* now recursively sort the level group structures */ - node = *node_first; - while (node) + if (!setup.override_level_graphics) { - if (node->node_group != NULL) - sortLevelDirInfo(&node->node_group, compare_function); +#if 1 + /* try special ECS graphics */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_ECS_DIRECTORY, basename); + if (fileExists(filename) && !setup.prefer_aga_graphics) + return filename; - node = node->next; - } -} + free(filename); + /* try special AGA graphics */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_AGA_DIRECTORY, basename); + if (fileExists(filename) && setup.prefer_aga_graphics) + return filename; -/* ========================================================================= */ -/* some stuff from "files.c" */ -/* ========================================================================= */ + free(filename); +#endif -#if defined(PLATFORM_WIN32) -#ifndef S_IRGRP -#define S_IRGRP S_IRUSR -#endif -#ifndef S_IROTH -#define S_IROTH S_IRUSR -#endif -#ifndef S_IWGRP -#define S_IWGRP S_IWUSR -#endif -#ifndef S_IWOTH -#define S_IWOTH S_IWUSR -#endif -#ifndef S_IXGRP -#define S_IXGRP S_IXUSR -#endif -#ifndef S_IXOTH -#define S_IXOTH S_IXUSR -#endif -#ifndef S_IRWXG -#define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP) + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; + + free(filename); + +#if 1 + if (leveldir_current) + printf("::: A -> '%s' [%s]\n", leveldir_current->graphics_set, + leveldir_current->subdir); #endif -#ifndef S_ISGID -#define S_ISGID 0 + + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL) + { +#if 1 + printf("::: B -> '%s' ---------> '%s'\n", + getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS), + leveldir_current->graphics_path); + /* -> getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS)); */ #endif -#endif /* PLATFORM_WIN32 */ -/* file permissions for newly written files */ -#define MODE_R_ALL (S_IRUSR | S_IRGRP | S_IROTH) -#define MODE_W_ALL (S_IWUSR | S_IWGRP | S_IWOTH) -#define MODE_X_ALL (S_IXUSR | S_IXGRP | S_IXOTH) + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename); + if (fileExists(filename)) + return filename; -#define MODE_W_PRIVATE (S_IWUSR) -#define MODE_W_PUBLIC (S_IWUSR | S_IWGRP) -#define MODE_W_PUBLIC_DIR (S_IWUSR | S_IWGRP | S_ISGID) + free(filename); -#define DIR_PERMS_PRIVATE (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE) -#define DIR_PERMS_PUBLIC (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR) + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } -#define FILE_PERMS_PRIVATE (MODE_R_ALL | MODE_W_PRIVATE) -#define FILE_PERMS_PUBLIC (MODE_R_ALL | MODE_W_PUBLIC) + if (!skip_setup_artwork) + { + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename); + if (fileExists(filename)) + return filename; -char *getUserDataDir(void) + free(filename); + } + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.graphics_directory, basename); + if (fileExists(filename)) + return filename; + + return NULL; /* cannot find specified artwork file anywhere */ +} + +char *getCustomSoundFilename(char *basename) { - static char *userdata_dir = NULL; + static char *filename = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(filename); - if (!userdata_dir) + basename = getCorrectedArtworkBasename(basename); + + if (!setup.override_level_sounds) { - char *home_dir = getHomeDir(); - char *data_dir = program.userdata_directory; + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_SOUNDS) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_SOUNDS_DIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); - userdata_dir = getPath2(home_dir, data_dir); + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } } - return userdata_dir; + if (!skip_setup_artwork) + { + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.snd_current), basename); + if (fileExists(filename)) + return filename; + + free(filename); + } + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultSoundsDir(SND_CLASSIC_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.sounds_directory, basename); + if (fileExists(filename)) + return filename; + + return NULL; /* cannot find specified artwork file anywhere */ } -char *getSetupDir() +char *getCustomMusicFilename(char *basename) { - return getUserDataDir(); + static char *filename = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(filename); + + basename = getCorrectedArtworkBasename(basename); + + if (!setup.override_level_music) + { + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), MUSIC_DIRECTORY, basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } + + if (!skip_setup_artwork) + { + /* 3rd try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.mus_current), basename); + if (fileExists(filename)) + return filename; + + free(filename); + } + + /* 4th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultMusicDir(MUS_CLASSIC_SUBDIR), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* 5th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.music_directory, basename); + if (fileExists(filename)) + return filename; + + return NULL; /* cannot find specified artwork file anywhere */ } -static mode_t posix_umask(mode_t mask) +char *getCustomArtworkFilename(char *basename, int type) { -#if defined(PLATFORM_UNIX) - return umask(mask); -#else - return 0; -#endif + if (type == ARTWORK_TYPE_GRAPHICS) + return getCustomImageFilename(basename); + else if (type == ARTWORK_TYPE_SOUNDS) + return getCustomSoundFilename(basename); + else if (type == ARTWORK_TYPE_MUSIC) + return getCustomMusicFilename(basename); + else + return UNDEFINED_FILENAME; } -static int posix_mkdir(const char *pathname, mode_t mode) +char *getCustomArtworkConfigFilename(int type) { -#if defined(PLATFORM_WIN32) - return mkdir(pathname); -#else - return mkdir(pathname, mode); -#endif + return getCustomArtworkFilename(ARTWORKINFO_FILENAME(type), type); } -void createDirectory(char *dir, char *text, int permission_class) +char *getCustomArtworkLevelConfigFilename(int type) { - /* leave "other" permissions in umask untouched, but ensure group parts - of USERDATA_DIR_MODE are not masked */ - mode_t dir_mode = (permission_class == PERMS_PRIVATE ? - DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC); - mode_t normal_umask = posix_umask(0); - mode_t group_umask = ~(dir_mode & S_IRWXG); - posix_umask(normal_umask & group_umask); + static char *filename = NULL; - if (access(dir, F_OK) != 0) - if (posix_mkdir(dir, dir_mode) != 0) - Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); + checked_free(filename); - posix_umask(normal_umask); /* reset normal umask */ + filename = getPath2(getLevelArtworkDir(type), ARTWORKINFO_FILENAME(type)); + + return filename; } -void InitUserDataDirectory() +char *getCustomMusicDirectory(void) +{ + static char *directory = NULL; + boolean skip_setup_artwork = FALSE; + + checked_free(directory); + + if (!setup.override_level_music) + { + /* 1st try: look for special artwork in current level series directory */ + directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY); + if (fileExists(directory)) + return directory; + + free(directory); + + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_MUSIC) != NULL) + { + /* 2nd try: look for special artwork configured in level series config */ + directory = getStringCopy(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } + + if (!skip_setup_artwork) + { + /* 3rd try: look for special artwork in configured artwork directory */ + directory = getStringCopy(getSetupArtworkDir(artwork.mus_current)); + if (fileExists(directory)) + return directory; + + free(directory); + } + + /* 4th try: look for default artwork in new default artwork directory */ + directory = getStringCopy(getDefaultMusicDir(MUS_CLASSIC_SUBDIR)); + if (fileExists(directory)) + return directory; + + free(directory); + + /* 5th try: look for default artwork in old default artwork directory */ + directory = getStringCopy(options.music_directory); + if (fileExists(directory)) + return directory; + + return NULL; /* cannot find specified artwork file anywhere */ +} + +void InitTapeDirectory(char *level_subdir) { createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getTapeDir(NULL), "main tape", PERMS_PRIVATE); + createDirectory(getTapeDir(level_subdir), "level tape", PERMS_PRIVATE); } -void SetFilePermissions(char *filename, int permission_class) +void InitScoreDirectory(char *level_subdir) { - chmod(filename, (permission_class == PERMS_PRIVATE ? - FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC)); + createDirectory(getCommonDataDir(), "common data", PERMS_PUBLIC); + createDirectory(getScoreDir(NULL), "main score", PERMS_PUBLIC); + createDirectory(getScoreDir(level_subdir), "level score", PERMS_PUBLIC); } -char *getCookie(char *file_type) +static void SaveUserLevelInfo(); + +void InitUserLevelDirectory(char *level_subdir) { - static char cookie[MAX_COOKIE_LEN + 1]; + if (!fileExists(getUserLevelDir(level_subdir))) + { + createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getUserLevelDir(NULL), "main user level", PERMS_PRIVATE); + createDirectory(getUserLevelDir(level_subdir), "user level",PERMS_PRIVATE); - if (strlen(program.cookie_prefix) + 1 + - strlen(file_type) + strlen("_FILE_VERSION_x.x") > MAX_COOKIE_LEN) - return "[COOKIE ERROR]"; /* should never happen */ + SaveUserLevelInfo(); + } +} - sprintf(cookie, "%s_%s_FILE_VERSION_%d.%d", - program.cookie_prefix, file_type, - program.version_major, program.version_minor); +void InitLevelSetupDirectory(char *level_subdir) +{ + createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); + createDirectory(getLevelSetupDir(NULL), "main level setup", PERMS_PRIVATE); + createDirectory(getLevelSetupDir(level_subdir), "level setup",PERMS_PRIVATE); +} - return cookie; + +/* ------------------------------------------------------------------------- */ +/* some functions to handle lists of level and artwork directories */ +/* ------------------------------------------------------------------------- */ + +TreeInfo *newTreeInfo() +{ + return checked_calloc(sizeof(TreeInfo)); } -int getFileVersionFromCookieString(const char *cookie) +void pushTreeInfo(TreeInfo **node_first, TreeInfo *node_new) { - const char *ptr_cookie1, *ptr_cookie2; - const char *pattern1 = "_FILE_VERSION_"; - const char *pattern2 = "?.?"; - const int len_cookie = strlen(cookie); - const int len_pattern1 = strlen(pattern1); - const int len_pattern2 = strlen(pattern2); - const int len_pattern = len_pattern1 + len_pattern2; - int version_major, version_minor; + node_new->next = *node_first; + *node_first = node_new; +} + +int numTreeInfo(TreeInfo *node) +{ + int num = 0; + + while (node) + { + num++; + node = node->next; + } + + return num; +} + +boolean validLevelSeries(TreeInfo *node) +{ + return (node != NULL && !node->node_group && !node->parent_link); +} + +TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *node) +{ + if (node == NULL) + return NULL; + + if (node->node_group) /* enter level group (step down into tree) */ + return getFirstValidTreeInfoEntry(node->node_group); + else if (node->parent_link) /* skip start entry of level group */ + { + if (node->next) /* get first real level series entry */ + return getFirstValidTreeInfoEntry(node->next); + else /* leave empty level group and go on */ + return getFirstValidTreeInfoEntry(node->node_parent->next); + } + else /* this seems to be a regular level series */ + return node; +} + +TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *node) +{ + if (node == NULL) + return NULL; + + if (node->node_parent == NULL) /* top level group */ + return *node->node_top; + else /* sub level group */ + return node->node_parent->node_group; +} + +int numTreeInfoInGroup(TreeInfo *node) +{ + return numTreeInfo(getTreeInfoFirstGroupEntry(node)); +} + +int posTreeInfo(TreeInfo *node) +{ + TreeInfo *node_cmp = getTreeInfoFirstGroupEntry(node); + int pos = 0; + + while (node_cmp) + { + if (node_cmp == node) + return pos; + + pos++; + node_cmp = node_cmp->next; + } + + return 0; +} + +TreeInfo *getTreeInfoFromPos(TreeInfo *node, int pos) +{ + TreeInfo *node_default = node; + int pos_cmp = 0; + + while (node) + { + if (pos_cmp == pos) + return node; + + pos_cmp++; + node = node->next; + } + + return node_default; +} + +TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier) +{ + if (identifier == NULL) + return NULL; + + while (node) + { + if (node->node_group) + { + TreeInfo *node_group; + + node_group = getTreeInfoFromIdentifier(node->node_group, identifier); + + if (node_group) + return node_group; + } + else if (!node->parent_link) + { + if (strcmp(identifier, node->identifier) == 0) + return node; + } + + node = node->next; + } + + return NULL; +} + +TreeInfo *cloneTreeNode(TreeInfo **node_top, TreeInfo *node_parent, + TreeInfo *node, boolean skip_sets_without_levels) +{ + TreeInfo *node_new; + + if (node == NULL) + return NULL; + + if (!node->parent_link && !node->level_group && + skip_sets_without_levels && node->levels == 0) + return cloneTreeNode(node_top, node_parent, node->next, + skip_sets_without_levels); + + node_new = newTreeInfo(); + + *node_new = *node; /* copy complete node */ + + node_new->node_top = node_top; /* correct top node link */ + node_new->node_parent = node_parent; /* correct parent node link */ + + if (node->level_group) + node_new->node_group = cloneTreeNode(node_top, node_new, node->node_group, + skip_sets_without_levels); + + node_new->next = cloneTreeNode(node_top, node_parent, node->next, + skip_sets_without_levels); + + return node_new; +} + +void cloneTree(TreeInfo **ti_new, TreeInfo *ti, boolean skip_empty_sets) +{ + TreeInfo *ti_cloned = cloneTreeNode(ti_new, NULL, ti, skip_empty_sets); + + *ti_new = ti_cloned; +} + +static boolean adjustTreeGraphics(TreeInfo *node) +{ + boolean settings_changed = FALSE; + + while (node) + { +#if 1 + if (node->graphics_ecs_set && !setup.prefer_aga_graphics) + { + setString(&node->graphics_set, node->graphics_ecs_set); +#if 0 + printf("::: setting graphics for set '%s' to '%s' [ECS]\n", + node->subdir, node->graphics_set); +#endif + + settings_changed = TRUE; + } + else if (node->graphics_aga_set && setup.prefer_aga_graphics) + { + setString(&node->graphics_set, node->graphics_aga_set); +#if 0 + printf("::: setting graphics for set '%s' to '%s' [AGA]\n", + node->subdir, node->graphics_set); +#endif + + settings_changed = TRUE; + } + else if (node->graphics_set == NULL) + { +#if 0 + printf("::: cannot set graphics_set for set '%s'\n", node->subdir); +#endif + } +#else + if (node->graphics_ecs_set) + printf("::: SET '%s': found ECS set '%s'\n", + node->subdir, node->graphics_ecs_set); + + if (node->graphics_aga_set) + printf("::: SET '%s': found AGA set '%s'\n", + node->subdir, node->graphics_aga_set); +#endif + + if (node->node_group != NULL) + settings_changed |= adjustTreeGraphics(node->node_group); + + node = node->next; + } + + return settings_changed; +} + +void dumpTreeInfo(TreeInfo *node, int depth) +{ + int i; + + printf("Dumping TreeInfo:\n"); + + while (node) + { + for (i = 0; i < (depth + 1) * 3; i++) + printf(" "); + + printf("subdir == '%s' ['%s', '%s'] [%d])\n", + node->subdir, node->fullpath, node->basepath, node->in_user_dir); + + if (node->node_group != NULL) + dumpTreeInfo(node->node_group, depth + 1); + + node = node->next; + } +} + +void sortTreeInfo(TreeInfo **node_first, + int (*compare_function)(const void *, const void *)) +{ + int num_nodes = numTreeInfo(*node_first); + TreeInfo **sort_array; + TreeInfo *node = *node_first; + int i = 0; + + if (num_nodes == 0) + return; + + /* allocate array for sorting structure pointers */ + sort_array = checked_calloc(num_nodes * sizeof(TreeInfo *)); + + /* writing structure pointers to sorting array */ + while (i < num_nodes && node) /* double boundary check... */ + { + sort_array[i] = node; + + i++; + node = node->next; + } + + /* sorting the structure pointers in the sorting array */ + qsort(sort_array, num_nodes, sizeof(TreeInfo *), + compare_function); + + /* update the linkage of list elements with the sorted node array */ + for (i = 0; i < num_nodes - 1; i++) + sort_array[i]->next = sort_array[i + 1]; + sort_array[num_nodes - 1]->next = NULL; + + /* update the linkage of the main list anchor pointer */ + *node_first = sort_array[0]; + + free(sort_array); + + /* now recursively sort the level group structures */ + node = *node_first; + while (node) + { + if (node->node_group != NULL) + sortTreeInfo(&node->node_group, compare_function); + + node = node->next; + } +} + + +/* ========================================================================= */ +/* some stuff from "files.c" */ +/* ========================================================================= */ + +#if defined(PLATFORM_WIN32) +#ifndef S_IRGRP +#define S_IRGRP S_IRUSR +#endif +#ifndef S_IROTH +#define S_IROTH S_IRUSR +#endif +#ifndef S_IWGRP +#define S_IWGRP S_IWUSR +#endif +#ifndef S_IWOTH +#define S_IWOTH S_IWUSR +#endif +#ifndef S_IXGRP +#define S_IXGRP S_IXUSR +#endif +#ifndef S_IXOTH +#define S_IXOTH S_IXUSR +#endif +#ifndef S_IRWXG +#define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP) +#endif +#ifndef S_ISGID +#define S_ISGID 0 +#endif +#endif /* PLATFORM_WIN32 */ + +/* file permissions for newly written files */ +#define MODE_R_ALL (S_IRUSR | S_IRGRP | S_IROTH) +#define MODE_W_ALL (S_IWUSR | S_IWGRP | S_IWOTH) +#define MODE_X_ALL (S_IXUSR | S_IXGRP | S_IXOTH) + +#define MODE_W_PRIVATE (S_IWUSR) +#define MODE_W_PUBLIC (S_IWUSR | S_IWGRP) +#define MODE_W_PUBLIC_DIR (S_IWUSR | S_IWGRP | S_ISGID) + +#define DIR_PERMS_PRIVATE (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE) +#define DIR_PERMS_PUBLIC (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR) + +#define FILE_PERMS_PRIVATE (MODE_R_ALL | MODE_W_PRIVATE) +#define FILE_PERMS_PUBLIC (MODE_R_ALL | MODE_W_PUBLIC) + +char *getUserDataDir(void) +{ + static char *userdata_dir = NULL; + + if (userdata_dir == NULL) + userdata_dir = getPath2(getHomeDir(), program.userdata_directory); + + return userdata_dir; +} + +char *getCommonDataDir(void) +{ + static char *common_data_dir = NULL; + +#if defined(PLATFORM_WIN32) + if (common_data_dir == NULL) + { + char *dir = checked_malloc(MAX_PATH + 1); + + if (SUCCEEDED(SHGetFolderPath(NULL, CSIDL_COMMON_DOCUMENTS, NULL, 0, dir)) + && strcmp(dir, "") != 0) /* empty for Windows 95/98 */ + common_data_dir = getPath2(dir, program.userdata_directory); + else + common_data_dir = options.rw_base_directory; + } +#else + if (common_data_dir == NULL) + common_data_dir = options.rw_base_directory; +#endif + + return common_data_dir; +} + +char *getSetupDir() +{ + return getUserDataDir(); +} + +static mode_t posix_umask(mode_t mask) +{ +#if defined(PLATFORM_UNIX) + return umask(mask); +#else + return 0; +#endif +} + +static int posix_mkdir(const char *pathname, mode_t mode) +{ +#if defined(PLATFORM_WIN32) + return mkdir(pathname); +#else + return mkdir(pathname, mode); +#endif +} + +void createDirectory(char *dir, char *text, int permission_class) +{ + /* leave "other" permissions in umask untouched, but ensure group parts + of USERDATA_DIR_MODE are not masked */ + mode_t dir_mode = (permission_class == PERMS_PRIVATE ? + DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC); + mode_t normal_umask = posix_umask(0); + mode_t group_umask = ~(dir_mode & S_IRWXG); + posix_umask(normal_umask & group_umask); + + if (!fileExists(dir)) + if (posix_mkdir(dir, dir_mode) != 0) + Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); + + posix_umask(normal_umask); /* reset normal umask */ +} + +void InitUserDataDirectory() +{ + createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE); +} + +void SetFilePermissions(char *filename, int permission_class) +{ + chmod(filename, (permission_class == PERMS_PRIVATE ? + FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC)); +} + +char *getCookie(char *file_type) +{ + static char cookie[MAX_COOKIE_LEN + 1]; + + if (strlen(program.cookie_prefix) + 1 + + strlen(file_type) + strlen("_FILE_VERSION_x.x") > MAX_COOKIE_LEN) + return "[COOKIE ERROR]"; /* should never happen */ + + sprintf(cookie, "%s_%s_FILE_VERSION_%d.%d", + program.cookie_prefix, file_type, + program.version_major, program.version_minor); + + return cookie; +} + +int getFileVersionFromCookieString(const char *cookie) +{ + const char *ptr_cookie1, *ptr_cookie2; + const char *pattern1 = "_FILE_VERSION_"; + const char *pattern2 = "?.?"; + const int len_cookie = strlen(cookie); + const int len_pattern1 = strlen(pattern1); + const int len_pattern2 = strlen(pattern2); + const int len_pattern = len_pattern1 + len_pattern2; + int version_major, version_minor; + + if (len_cookie <= len_pattern) + return -1; + + ptr_cookie1 = &cookie[len_cookie - len_pattern]; + ptr_cookie2 = &cookie[len_cookie - len_pattern2]; + + if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0) + return -1; + + if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' || + ptr_cookie2[1] != '.' || + ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9') + return -1; + + version_major = ptr_cookie2[0] - '0'; + version_minor = ptr_cookie2[2] - '0'; + + return VERSION_IDENT(version_major, version_minor, 0, 0); +} + +boolean checkCookieString(const char *cookie, const char *template) +{ + const char *pattern = "_FILE_VERSION_?.?"; + const int len_cookie = strlen(cookie); + const int len_template = strlen(template); + const int len_pattern = strlen(pattern); + + if (len_cookie != len_template) + return FALSE; + + if (strncmp(cookie, template, len_cookie - len_pattern) != 0) + return FALSE; + + return TRUE; +} + +/* ------------------------------------------------------------------------- */ +/* setup file list and hash handling functions */ +/* ------------------------------------------------------------------------- */ + +char *getFormattedSetupEntry(char *token, char *value) +{ + int i; + static char entry[MAX_LINE_LEN]; + + /* if value is an empty string, just return token without value */ + if (*value == '\0') + return token; + + /* start with the token and some spaces to format output line */ + sprintf(entry, "%s:", token); + for (i = strlen(entry); i < token_value_position; i++) + strcat(entry, " "); + + /* continue with the token's value */ + strcat(entry, value); + + return entry; +} + +SetupFileList *newSetupFileList(char *token, char *value) +{ + SetupFileList *new = checked_malloc(sizeof(SetupFileList)); + + new->token = getStringCopy(token); + new->value = getStringCopy(value); + + new->next = NULL; + + return new; +} + +void freeSetupFileList(SetupFileList *list) +{ + if (list == NULL) + return; + + checked_free(list->token); + checked_free(list->value); + + if (list->next) + freeSetupFileList(list->next); + + free(list); +} + +char *getListEntry(SetupFileList *list, char *token) +{ + if (list == NULL) + return NULL; + + if (strcmp(list->token, token) == 0) + return list->value; + else + return getListEntry(list->next, token); +} + +SetupFileList *setListEntry(SetupFileList *list, char *token, char *value) +{ + if (list == NULL) + return NULL; + + if (strcmp(list->token, token) == 0) + { + checked_free(list->value); + + list->value = getStringCopy(value); + + return list; + } + else if (list->next == NULL) + return (list->next = newSetupFileList(token, value)); + else + return setListEntry(list->next, token, value); +} + +SetupFileList *addListEntry(SetupFileList *list, char *token, char *value) +{ + if (list == NULL) + return NULL; + + if (list->next == NULL) + return (list->next = newSetupFileList(token, value)); + else + return addListEntry(list->next, token, value); +} + +#ifdef DEBUG +static void printSetupFileList(SetupFileList *list) +{ + if (!list) + return; + + printf("token: '%s'\n", list->token); + printf("value: '%s'\n", list->value); + + printSetupFileList(list->next); +} +#endif + +#ifdef DEBUG +DEFINE_HASHTABLE_INSERT(insert_hash_entry, char, char); +DEFINE_HASHTABLE_SEARCH(search_hash_entry, char, char); +DEFINE_HASHTABLE_CHANGE(change_hash_entry, char, char); +DEFINE_HASHTABLE_REMOVE(remove_hash_entry, char, char); +#else +#define insert_hash_entry hashtable_insert +#define search_hash_entry hashtable_search +#define change_hash_entry hashtable_change +#define remove_hash_entry hashtable_remove +#endif + +static unsigned int get_hash_from_key(void *key) +{ + /* + djb2 + + This algorithm (k=33) was first reported by Dan Bernstein many years ago in + 'comp.lang.c'. Another version of this algorithm (now favored by Bernstein) + uses XOR: hash(i) = hash(i - 1) * 33 ^ str[i]; the magic of number 33 (why + it works better than many other constants, prime or not) has never been + adequately explained. + + If you just want to have a good hash function, and cannot wait, djb2 + is one of the best string hash functions i know. It has excellent + distribution and speed on many different sets of keys and table sizes. + You are not likely to do better with one of the "well known" functions + such as PJW, K&R, etc. + + Ozan (oz) Yigit [http://www.cs.yorku.ca/~oz/hash.html] + */ + + char *str = (char *)key; + unsigned int hash = 5381; + int c; + + while ((c = *str++)) + hash = ((hash << 5) + hash) + c; /* hash * 33 + c */ + + return hash; +} + +static int keys_are_equal(void *key1, void *key2) +{ + return (strcmp((char *)key1, (char *)key2) == 0); +} + +SetupFileHash *newSetupFileHash() +{ + SetupFileHash *new_hash = + create_hashtable(16, 0.75, get_hash_from_key, keys_are_equal); + + if (new_hash == NULL) + Error(ERR_EXIT, "create_hashtable() failed -- out of memory"); + + return new_hash; +} + +void freeSetupFileHash(SetupFileHash *hash) +{ + if (hash == NULL) + return; + + hashtable_destroy(hash, 1); /* 1 == also free values stored in hash */ +} + +char *getHashEntry(SetupFileHash *hash, char *token) +{ + if (hash == NULL) + return NULL; + + return search_hash_entry(hash, token); +} + +void setHashEntry(SetupFileHash *hash, char *token, char *value) +{ + char *value_copy; + + if (hash == NULL) + return; + + value_copy = getStringCopy(value); + + /* change value; if it does not exist, insert it as new */ + if (!change_hash_entry(hash, token, value_copy)) + if (!insert_hash_entry(hash, getStringCopy(token), value_copy)) + Error(ERR_EXIT, "cannot insert into hash -- aborting"); +} + +char *removeHashEntry(SetupFileHash *hash, char *token) +{ + if (hash == NULL) + return NULL; + + return remove_hash_entry(hash, token); +} + +#if 0 +static void printSetupFileHash(SetupFileHash *hash) +{ + BEGIN_HASH_ITERATION(hash, itr) + { + printf("token: '%s'\n", HASH_ITERATION_TOKEN(itr)); + printf("value: '%s'\n", HASH_ITERATION_VALUE(itr)); + } + END_HASH_ITERATION(hash, itr) +} +#endif + +static void *loadSetupFileData(char *filename, boolean use_hash) +{ + char line[MAX_LINE_LEN], previous_line[MAX_LINE_LEN]; + char *token, *value, *line_ptr; + void *setup_file_data, *insert_ptr = NULL; + boolean read_continued_line = FALSE; + FILE *file; + + if (!(file = fopen(filename, MODE_READ))) + { + Error(ERR_WARN, "cannot open configuration file '%s'", filename); + + return NULL; + } + + if (use_hash) + setup_file_data = newSetupFileHash(); + else + insert_ptr = setup_file_data = newSetupFileList("", ""); + + while (!feof(file)) + { + /* read next line of input file */ + if (!fgets(line, MAX_LINE_LEN, file)) + break; + + /* cut trailing newline or carriage return */ + for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--) + if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0') + *line_ptr = '\0'; + + if (read_continued_line) + { + /* cut leading whitespaces from input line */ + for (line_ptr = line; *line_ptr; line_ptr++) + if (*line_ptr != ' ' && *line_ptr != '\t') + break; + + /* append new line to existing line, if there is enough space */ + if (strlen(previous_line) + strlen(line_ptr) < MAX_LINE_LEN) + strcat(previous_line, line_ptr); + + strcpy(line, previous_line); /* copy storage buffer to line */ + + read_continued_line = FALSE; + } + + /* if the last character is '\', continue at next line */ + if (strlen(line) > 0 && line[strlen(line) - 1] == '\\') + { + line[strlen(line) - 1] = '\0'; /* cut off trailing backslash */ + strcpy(previous_line, line); /* copy line to storage buffer */ + + read_continued_line = TRUE; + + continue; + } + + /* cut trailing comment from input line */ + for (line_ptr = line; *line_ptr; line_ptr++) + { + if (*line_ptr == '#') + { + *line_ptr = '\0'; + break; + } + } + + /* cut trailing whitespaces from input line */ + for (line_ptr = &line[strlen(line)]; line_ptr >= line; line_ptr--) + if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0') + *line_ptr = '\0'; + + /* ignore empty lines */ + if (*line == '\0') + continue; + + /* cut leading whitespaces from token */ + for (token = line; *token; token++) + if (*token != ' ' && *token != '\t') + break; + + /* start with empty value as reliable default */ + value = ""; + + /* find end of token to determine start of value */ + for (line_ptr = token; *line_ptr; line_ptr++) + { + if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':') + { + *line_ptr = '\0'; /* terminate token string */ + value = line_ptr + 1; /* set beginning of value */ + + break; + } + } + + /* cut leading whitespaces from value */ + for (; *value; value++) + if (*value != ' ' && *value != '\t') + break; + +#if 0 + if (*value == '\0') + value = "true"; /* treat tokens without value as "true" */ +#endif + + if (*token) + { + if (use_hash) + setHashEntry((SetupFileHash *)setup_file_data, token, value); + else + insert_ptr = addListEntry((SetupFileList *)insert_ptr, token, value); + } + } + + fclose(file); + + if (use_hash) + { + if (hashtable_count((SetupFileHash *)setup_file_data) == 0) + Error(ERR_WARN, "configuration file '%s' is empty", filename); + } + else + { + SetupFileList *setup_file_list = (SetupFileList *)setup_file_data; + SetupFileList *first_valid_list_entry = setup_file_list->next; + + /* free empty list header */ + setup_file_list->next = NULL; + freeSetupFileList(setup_file_list); + setup_file_data = first_valid_list_entry; + + if (first_valid_list_entry == NULL) + Error(ERR_WARN, "configuration file '%s' is empty", filename); + } + + return setup_file_data; +} + +SetupFileList *loadSetupFileList(char *filename) +{ + return (SetupFileList *)loadSetupFileData(filename, FALSE); +} + +SetupFileHash *loadSetupFileHash(char *filename) +{ + return (SetupFileHash *)loadSetupFileData(filename, TRUE); +} + +void checkSetupFileHashIdentifier(SetupFileHash *setup_file_hash, + char *filename, char *identifier) +{ + char *value = getHashEntry(setup_file_hash, TOKEN_STR_FILE_IDENTIFIER); + + if (value == NULL) + Error(ERR_WARN, "config file '%s' has no file identifier", filename); + else if (!checkCookieString(value, identifier)) + Error(ERR_WARN, "config file '%s' has wrong file identifier", filename); +} + + +/* ========================================================================= */ +/* setup file stuff */ +/* ========================================================================= */ + +#define TOKEN_STR_LAST_LEVEL_SERIES "last_level_series" +#define TOKEN_STR_LAST_PLAYED_LEVEL "last_played_level" +#define TOKEN_STR_HANDICAP_LEVEL "handicap_level" + +/* level directory info */ +#define LEVELINFO_TOKEN_IDENTIFIER 0 +#define LEVELINFO_TOKEN_NAME 1 +#define LEVELINFO_TOKEN_NAME_SORTING 2 +#define LEVELINFO_TOKEN_AUTHOR 3 +#define LEVELINFO_TOKEN_IMPORTED_FROM 4 +#define LEVELINFO_TOKEN_IMPORTED_BY 5 +#define LEVELINFO_TOKEN_LEVELS 6 +#define LEVELINFO_TOKEN_FIRST_LEVEL 7 +#define LEVELINFO_TOKEN_SORT_PRIORITY 8 +#define LEVELINFO_TOKEN_LATEST_ENGINE 9 +#define LEVELINFO_TOKEN_LEVEL_GROUP 10 +#define LEVELINFO_TOKEN_READONLY 11 +#define LEVELINFO_TOKEN_GRAPHICS_ECS_SET 12 +#define LEVELINFO_TOKEN_GRAPHICS_AGA_SET 13 +#define LEVELINFO_TOKEN_GRAPHICS_SET 14 +#define LEVELINFO_TOKEN_SOUNDS_SET 15 +#define LEVELINFO_TOKEN_MUSIC_SET 16 +#define LEVELINFO_TOKEN_FILENAME 17 +#define LEVELINFO_TOKEN_FILETYPE 18 +#define LEVELINFO_TOKEN_HANDICAP 19 +#define LEVELINFO_TOKEN_SKIP_LEVELS 20 + +#define NUM_LEVELINFO_TOKENS 21 + +static LevelDirTree ldi; + +static struct TokenInfo levelinfo_tokens[] = +{ + /* level directory info */ + { TYPE_STRING, &ldi.identifier, "identifier" }, + { TYPE_STRING, &ldi.name, "name" }, + { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, + { TYPE_STRING, &ldi.author, "author" }, + { TYPE_STRING, &ldi.imported_from, "imported_from" }, + { TYPE_STRING, &ldi.imported_by, "imported_by" }, + { TYPE_INTEGER, &ldi.levels, "levels" }, + { TYPE_INTEGER, &ldi.first_level, "first_level" }, + { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, + { TYPE_BOOLEAN, &ldi.latest_engine, "latest_engine" }, + { TYPE_BOOLEAN, &ldi.level_group, "level_group" }, + { TYPE_BOOLEAN, &ldi.readonly, "readonly" }, + { TYPE_STRING, &ldi.graphics_ecs_set, "graphics_ecs_set" }, + { TYPE_STRING, &ldi.graphics_aga_set, "graphics_aga_set" }, + { TYPE_STRING, &ldi.graphics_set, "graphics_set" }, + { TYPE_STRING, &ldi.sounds_set, "sounds_set" }, + { TYPE_STRING, &ldi.music_set, "music_set" }, + { TYPE_STRING, &ldi.level_filename, "filename" }, + { TYPE_STRING, &ldi.level_filetype, "filetype" }, + { TYPE_BOOLEAN, &ldi.handicap, "handicap" }, + { TYPE_BOOLEAN, &ldi.skip_levels, "skip_levels" } +}; + +static void setTreeInfoToDefaults(TreeInfo *ldi, int type) +{ + ldi->type = type; + + ldi->node_top = (ldi->type == TREE_TYPE_LEVEL_DIR ? &leveldir_first : + ldi->type == TREE_TYPE_GRAPHICS_DIR ? &artwork.gfx_first : + ldi->type == TREE_TYPE_SOUNDS_DIR ? &artwork.snd_first : + ldi->type == TREE_TYPE_MUSIC_DIR ? &artwork.mus_first : + NULL); + + ldi->node_parent = NULL; + ldi->node_group = NULL; + ldi->next = NULL; + + ldi->cl_first = -1; + ldi->cl_cursor = -1; + + ldi->subdir = NULL; + ldi->fullpath = NULL; + ldi->basepath = NULL; + ldi->identifier = NULL; + ldi->name = getStringCopy(ANONYMOUS_NAME); + ldi->name_sorting = NULL; + ldi->author = getStringCopy(ANONYMOUS_NAME); + + ldi->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ + ldi->latest_engine = FALSE; /* default: get from level */ + ldi->parent_link = FALSE; + ldi->in_user_dir = FALSE; + ldi->user_defined = FALSE; + ldi->color = 0; + ldi->class_desc = NULL; + + if (ldi->type == TREE_TYPE_LEVEL_DIR) + { + ldi->imported_from = NULL; + ldi->imported_by = NULL; + + ldi->graphics_ecs_set = NULL; + ldi->graphics_aga_set = NULL; + ldi->graphics_set = NULL; + ldi->sounds_set = NULL; + ldi->music_set = NULL; + ldi->graphics_path = getStringCopy(UNDEFINED_FILENAME); + ldi->sounds_path = getStringCopy(UNDEFINED_FILENAME); + ldi->music_path = getStringCopy(UNDEFINED_FILENAME); + + ldi->level_filename = NULL; + ldi->level_filetype = NULL; + + ldi->levels = 0; + ldi->first_level = 0; + ldi->last_level = 0; + ldi->level_group = FALSE; + ldi->handicap_level = 0; + ldi->readonly = TRUE; + ldi->handicap = TRUE; + ldi->skip_levels = FALSE; + } +} + +static void setTreeInfoToDefaultsFromParent(TreeInfo *ldi, TreeInfo *parent) +{ + if (parent == NULL) + { + Error(ERR_WARN, "setTreeInfoToDefaultsFromParent(): parent == NULL"); + + setTreeInfoToDefaults(ldi, TREE_TYPE_UNDEFINED); + + return; + } + + /* copy all values from the parent structure */ - if (len_cookie <= len_pattern) - return -1; + ldi->type = parent->type; - ptr_cookie1 = &cookie[len_cookie - len_pattern]; - ptr_cookie2 = &cookie[len_cookie - len_pattern2]; + ldi->node_top = parent->node_top; + ldi->node_parent = parent; + ldi->node_group = NULL; + ldi->next = NULL; - if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0) - return -1; + ldi->cl_first = -1; + ldi->cl_cursor = -1; - if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' || - ptr_cookie2[1] != '.' || - ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9') - return -1; + ldi->subdir = NULL; + ldi->fullpath = NULL; + ldi->basepath = NULL; + ldi->identifier = NULL; + ldi->name = getStringCopy(ANONYMOUS_NAME); + ldi->name_sorting = NULL; + ldi->author = getStringCopy(parent->author); - version_major = ptr_cookie2[0] - '0'; - version_minor = ptr_cookie2[2] - '0'; + ldi->sort_priority = parent->sort_priority; + ldi->latest_engine = parent->latest_engine; + ldi->parent_link = FALSE; + ldi->in_user_dir = parent->in_user_dir; + ldi->user_defined = parent->user_defined; + ldi->color = parent->color; + ldi->class_desc = getStringCopy(parent->class_desc); - return VERSION_IDENT(version_major, version_minor, 0); + if (ldi->type == TREE_TYPE_LEVEL_DIR) + { + ldi->imported_from = getStringCopy(parent->imported_from); + ldi->imported_by = getStringCopy(parent->imported_by); + + ldi->graphics_ecs_set = NULL; + ldi->graphics_aga_set = NULL; + ldi->graphics_set = NULL; + ldi->sounds_set = NULL; + ldi->music_set = NULL; + ldi->graphics_path = getStringCopy(UNDEFINED_FILENAME); + ldi->sounds_path = getStringCopy(UNDEFINED_FILENAME); + ldi->music_path = getStringCopy(UNDEFINED_FILENAME); + + ldi->level_filename = NULL; + ldi->level_filetype = NULL; + + ldi->levels = 0; + ldi->first_level = 0; + ldi->last_level = 0; + ldi->level_group = FALSE; + ldi->handicap_level = 0; + ldi->readonly = TRUE; + ldi->handicap = TRUE; + ldi->skip_levels = FALSE; + } } -boolean checkCookieString(const char *cookie, const char *template) +static void freeTreeInfo(TreeInfo *ldi) { - const char *pattern = "_FILE_VERSION_?.?"; - const int len_cookie = strlen(cookie); - const int len_template = strlen(template); - const int len_pattern = strlen(pattern); + checked_free(ldi->subdir); + checked_free(ldi->fullpath); + checked_free(ldi->basepath); + checked_free(ldi->identifier); - if (len_cookie != len_template) - return FALSE; + checked_free(ldi->name); + checked_free(ldi->name_sorting); + checked_free(ldi->author); - if (strncmp(cookie, template, len_cookie - len_pattern) != 0) - return FALSE; + checked_free(ldi->class_desc); - return TRUE; -} + if (ldi->type == TREE_TYPE_LEVEL_DIR) + { + checked_free(ldi->imported_from); + checked_free(ldi->imported_by); -/* ------------------------------------------------------------------------- */ -/* setup file list handling functions */ -/* ------------------------------------------------------------------------- */ + checked_free(ldi->graphics_ecs_set); + checked_free(ldi->graphics_aga_set); + checked_free(ldi->graphics_set); + checked_free(ldi->sounds_set); + checked_free(ldi->music_set); -int get_string_integer_value(char *s) -{ - static char *number_text[][3] = - { - { "0", "zero", "null", }, - { "1", "one", "first" }, - { "2", "two", "second" }, - { "3", "three", "third" }, - { "4", "four", "fourth" }, - { "5", "five", "fifth" }, - { "6", "six", "sixth" }, - { "7", "seven", "seventh" }, - { "8", "eight", "eighth" }, - { "9", "nine", "ninth" }, - { "10", "ten", "tenth" }, - { "11", "eleven", "eleventh" }, - { "12", "twelve", "twelfth" }, - }; + checked_free(ldi->graphics_path); + checked_free(ldi->sounds_path); + checked_free(ldi->music_path); - int i, j; - char *s_lower = getStringToLower(s); - int result = -1; + checked_free(ldi->level_filename); + checked_free(ldi->level_filetype); + } +} - for (i=0; i<13; i++) - for (j=0; j<3; j++) - if (strcmp(s_lower, number_text[i][j]) == 0) - result = i; +void setSetupInfo(struct TokenInfo *token_info, + int token_nr, char *token_value) +{ + int token_type = token_info[token_nr].type; + void *setup_value = token_info[token_nr].value; - if (result == -1) - result = atoi(s); + if (token_value == NULL) + return; - free(s_lower); + /* set setup field to corresponding token value */ + switch (token_type) + { + case TYPE_BOOLEAN: + case TYPE_SWITCH: + *(boolean *)setup_value = get_boolean_from_string(token_value); + break; - return result; -} + case TYPE_KEY: + *(Key *)setup_value = getKeyFromKeyName(token_value); + break; -boolean get_string_boolean_value(char *s) -{ - char *s_lower = getStringToLower(s); - boolean result = FALSE; + case TYPE_KEY_X11: + *(Key *)setup_value = getKeyFromX11KeyName(token_value); + break; - if (strcmp(s_lower, "true") == 0 || - strcmp(s_lower, "yes") == 0 || - strcmp(s_lower, "on") == 0 || - get_string_integer_value(s) == 1) - result = TRUE; + case TYPE_INTEGER: + *(int *)setup_value = get_integer_from_string(token_value); + break; - free(s_lower); + case TYPE_STRING: + checked_free(*(char **)setup_value); + *(char **)setup_value = getStringCopy(token_value); + break; - return result; + default: + break; + } } -char *getFormattedSetupEntry(char *token, char *value) +static int compareTreeInfoEntries(const void *object1, const void *object2) { - int i; - static char entry[MAX_LINE_LEN]; + const TreeInfo *entry1 = *((TreeInfo **)object1); + const TreeInfo *entry2 = *((TreeInfo **)object2); + int class_sorting1, class_sorting2; + int compare_result; - sprintf(entry, "%s:", token); - for (i=strlen(entry); itype == TREE_TYPE_LEVEL_DIR) + { + class_sorting1 = LEVELSORTING(entry1); + class_sorting2 = LEVELSORTING(entry2); + } + else + { + class_sorting1 = ARTWORKSORTING(entry1); + class_sorting2 = ARTWORKSORTING(entry2); + } - strcat(entry, value); + if (entry1->parent_link || entry2->parent_link) + compare_result = (entry1->parent_link ? -1 : +1); + else if (entry1->sort_priority == entry2->sort_priority) + { + char *name1 = getStringToLower(entry1->name_sorting); + char *name2 = getStringToLower(entry2->name_sorting); - return entry; + compare_result = strcmp(name1, name2); + + free(name1); + free(name2); + } + else if (class_sorting1 == class_sorting2) + compare_result = entry1->sort_priority - entry2->sort_priority; + else + compare_result = class_sorting1 - class_sorting2; + + return compare_result; } -void freeSetupFileList(struct SetupFileList *setup_file_list) +static void createParentTreeInfoNode(TreeInfo *node_parent) { - if (!setup_file_list) + TreeInfo *ti_new; + + if (node_parent == NULL) return; - if (setup_file_list->token) - free(setup_file_list->token); - if (setup_file_list->value) - free(setup_file_list->value); - if (setup_file_list->next) - freeSetupFileList(setup_file_list->next); - free(setup_file_list); -} + ti_new = newTreeInfo(); + setTreeInfoToDefaults(ti_new, node_parent->type); -static struct SetupFileList *newSetupFileList(char *token, char *value) -{ - struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList)); + ti_new->node_parent = node_parent; + ti_new->parent_link = TRUE; - new->token = checked_malloc(strlen(token) + 1); - strcpy(new->token, token); + setString(&ti_new->identifier, node_parent->identifier); + setString(&ti_new->name, ".. (parent directory)"); + setString(&ti_new->name_sorting, ti_new->name); - new->value = checked_malloc(strlen(value) + 1); - strcpy(new->value, value); + setString(&ti_new->subdir, ".."); + setString(&ti_new->fullpath, node_parent->fullpath); - new->next = NULL; + ti_new->sort_priority = node_parent->sort_priority; + ti_new->latest_engine = node_parent->latest_engine; - return new; + setString(&ti_new->class_desc, getLevelClassDescription(ti_new)); + + pushTreeInfo(&node_parent->node_group, ti_new); } -char *getTokenValue(struct SetupFileList *setup_file_list, char *token) +/* forward declaration for recursive call by "LoadLevelInfoFromLevelDir()" */ +static void LoadLevelInfoFromLevelDir(TreeInfo **, TreeInfo *, char *); + +static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, + TreeInfo *node_parent, + char *level_directory, + char *directory_name) { - if (!setup_file_list) - return NULL; + char *directory_path = getPath2(level_directory, directory_name); + char *filename = getPath2(directory_path, LEVELINFO_FILENAME); + SetupFileHash *setup_file_hash; + LevelDirTree *leveldir_new = NULL; + int i; - if (strcmp(setup_file_list->token, token) == 0) - return setup_file_list->value; - else - return getTokenValue(setup_file_list->next, token); -} + /* unless debugging, silently ignore directories without "levelinfo.conf" */ + if (!options.debug && !fileExists(filename)) + { + free(directory_path); + free(filename); -static void setTokenValue(struct SetupFileList *setup_file_list, - char *token, char *value) -{ - if (!setup_file_list) - return; + return FALSE; + } - if (strcmp(setup_file_list->token, token) == 0) + setup_file_hash = loadSetupFileHash(filename); + + if (setup_file_hash == NULL) { - free(setup_file_list->value); - setup_file_list->value = checked_malloc(strlen(value) + 1); - strcpy(setup_file_list->value, value); + Error(ERR_WARN, "ignoring level directory '%s'", directory_path); + + free(directory_path); + free(filename); + + return FALSE; } - else if (setup_file_list->next == NULL) - setup_file_list->next = newSetupFileList(token, value); + + leveldir_new = newTreeInfo(); + + if (node_parent) + setTreeInfoToDefaultsFromParent(leveldir_new, node_parent); else - setTokenValue(setup_file_list->next, token, value); -} + setTreeInfoToDefaults(leveldir_new, TREE_TYPE_LEVEL_DIR); -#ifdef DEBUG -static void printSetupFileList(struct SetupFileList *setup_file_list) -{ - if (!setup_file_list) - return; + leveldir_new->subdir = getStringCopy(directory_name); - printf("token: '%s'\n", setup_file_list->token); - printf("value: '%s'\n", setup_file_list->value); + checkSetupFileHashIdentifier(setup_file_hash, filename, + getCookie("LEVELINFO")); - printSetupFileList(setup_file_list->next); -} -#endif + /* set all structure fields according to the token/value pairs */ + ldi = *leveldir_new; + for (i = 0; i < NUM_LEVELINFO_TOKENS; i++) + setSetupInfo(levelinfo_tokens, i, + getHashEntry(setup_file_hash, levelinfo_tokens[i].text)); + *leveldir_new = ldi; -struct SetupFileList *loadSetupFileList(char *filename) -{ - int line_len; - char line[MAX_LINE_LEN]; - char *token, *value, *line_ptr; - struct SetupFileList *setup_file_list = newSetupFileList("", ""); - struct SetupFileList *first_valid_list_entry; + if (strcmp(leveldir_new->name, ANONYMOUS_NAME) == 0) + setString(&leveldir_new->name, leveldir_new->subdir); - FILE *file; + DrawInitText(leveldir_new->name, 150, FC_YELLOW); - if (!(file = fopen(filename, MODE_READ))) + if (leveldir_new->identifier == NULL) + leveldir_new->identifier = getStringCopy(leveldir_new->subdir); + + if (leveldir_new->name_sorting == NULL) + leveldir_new->name_sorting = getStringCopy(leveldir_new->name); + + if (node_parent == NULL) /* top level group */ { - Error(ERR_WARN, "cannot open configuration file '%s'", filename); - return NULL; + leveldir_new->basepath = getStringCopy(level_directory); + leveldir_new->fullpath = getStringCopy(leveldir_new->subdir); } - - while(!feof(file)) + else /* sub level group */ { - /* read next line of input file */ - if (!fgets(line, MAX_LINE_LEN, file)) - break; + leveldir_new->basepath = getStringCopy(node_parent->basepath); + leveldir_new->fullpath = getPath2(node_parent->fullpath, directory_name); + } - /* cut trailing comment or whitespace from input line */ - for (line_ptr = line; *line_ptr; line_ptr++) - { - if (*line_ptr == '#' || *line_ptr == '\n' || *line_ptr == '\r') - { - *line_ptr = '\0'; - break; - } - } +#if 0 + if (leveldir_new->levels < 1) + leveldir_new->levels = 1; +#endif - /* cut trailing whitespaces from input line */ - for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--) - if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0') - *line_ptr = '\0'; + leveldir_new->last_level = + leveldir_new->first_level + leveldir_new->levels - 1; - /* ignore empty lines */ - if (*line == '\0') - continue; + leveldir_new->in_user_dir = + (strcmp(leveldir_new->basepath, options.level_directory) != 0); - line_len = strlen(line); + /* adjust some settings if user's private level directory was detected */ + if (leveldir_new->sort_priority == LEVELCLASS_UNDEFINED && + leveldir_new->in_user_dir && + (strcmp(leveldir_new->subdir, getLoginName()) == 0 || + strcmp(leveldir_new->name, getLoginName()) == 0 || + strcmp(leveldir_new->author, getRealName()) == 0)) + { + leveldir_new->sort_priority = LEVELCLASS_PRIVATE_START; + leveldir_new->readonly = FALSE; + } - /* cut leading whitespaces from token */ - for (token = line; *token; token++) - if (*token != ' ' && *token != '\t') - break; + leveldir_new->user_defined = + (leveldir_new->in_user_dir && IS_LEVELCLASS_PRIVATE(leveldir_new)); - /* find end of token */ - for (line_ptr = token; *line_ptr; line_ptr++) - { - if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':') - { - *line_ptr = '\0'; - break; - } - } + leveldir_new->color = LEVELCOLOR(leveldir_new); - if (line_ptr < line + line_len) - value = line_ptr + 1; - else - value = "\0"; + setString(&leveldir_new->class_desc, getLevelClassDescription(leveldir_new)); - /* cut leading whitespaces from value */ - for (; *value; value++) - if (*value != ' ' && *value != '\t') - break; + leveldir_new->handicap_level = /* set handicap to default value */ + (leveldir_new->user_defined || !leveldir_new->handicap ? + leveldir_new->last_level : leveldir_new->first_level); + +#if 0 + /* !!! don't skip sets without levels (else artwork base sets are missing) */ +#if 1 + if (leveldir_new->levels < 1 && !leveldir_new->level_group) + { + /* skip level sets without levels (which are probably artwork base sets) */ + + freeSetupFileHash(setup_file_hash); + free(directory_path); + free(filename); - if (*token && *value) - setTokenValue(setup_file_list, token, value); + return FALSE; } +#endif +#endif - fclose(file); + pushTreeInfo(node_first, leveldir_new); - first_valid_list_entry = setup_file_list->next; + freeSetupFileHash(setup_file_hash); - /* free empty list header */ - setup_file_list->next = NULL; - freeSetupFileList(setup_file_list); + if (leveldir_new->level_group) + { + /* create node to link back to current level directory */ + createParentTreeInfoNode(leveldir_new); + + /* step into sub-directory and look for more level series */ + LoadLevelInfoFromLevelDir(&leveldir_new->node_group, + leveldir_new, directory_path); + } - if (first_valid_list_entry == NULL) - Error(ERR_WARN, "configuration file '%s' is empty", filename); + free(directory_path); + free(filename); - return first_valid_list_entry; + return TRUE; } -void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list, - char *identifier) +static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, + TreeInfo *node_parent, + char *level_directory) { - if (!setup_file_list) + DIR *dir; + struct dirent *dir_entry; + boolean valid_entry_found = FALSE; + + if ((dir = opendir(level_directory)) == NULL) + { + Error(ERR_WARN, "cannot read level directory '%s'", level_directory); return; + } - if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0) + while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */ { - if (!checkCookieString(setup_file_list->value, identifier)) + struct stat file_status; + char *directory_name = dir_entry->d_name; + char *directory_path = getPath2(level_directory, directory_name); + + /* skip entries for current and parent directory */ + if (strcmp(directory_name, ".") == 0 || + strcmp(directory_name, "..") == 0) { - Error(ERR_WARN, "configuration file has wrong file identifier"); - return; + free(directory_path); + continue; } - else - return; - } - if (setup_file_list->next) - checkSetupFileListIdentifier(setup_file_list->next, identifier); - else - { - Error(ERR_WARN, "configuration file has no file identifier"); - return; - } -} + /* find out if directory entry is itself a directory */ + if (stat(directory_path, &file_status) != 0 || /* cannot stat file */ + (file_status.st_mode & S_IFMT) != S_IFDIR) /* not a directory */ + { + free(directory_path); + continue; + } + free(directory_path); -/* ========================================================================= */ -/* setup file stuff */ -/* ========================================================================= */ + if (strcmp(directory_name, GRAPHICS_DIRECTORY) == 0 || + strcmp(directory_name, SOUNDS_DIRECTORY) == 0 || + strcmp(directory_name, MUSIC_DIRECTORY) == 0) + continue; -#define TOKEN_STR_LAST_LEVEL_SERIES "last_level_series" -#define TOKEN_STR_LAST_PLAYED_LEVEL "last_played_level" -#define TOKEN_STR_HANDICAP_LEVEL "handicap_level" + valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, + level_directory, + directory_name); + } -/* level directory info */ -#define LEVELINFO_TOKEN_NAME 0 -#define LEVELINFO_TOKEN_NAME_SHORT 1 -#define LEVELINFO_TOKEN_NAME_SORTING 2 -#define LEVELINFO_TOKEN_AUTHOR 3 -#define LEVELINFO_TOKEN_IMPORTED_FROM 4 -#define LEVELINFO_TOKEN_LEVELS 5 -#define LEVELINFO_TOKEN_FIRST_LEVEL 6 -#define LEVELINFO_TOKEN_SORT_PRIORITY 7 -#define LEVELINFO_TOKEN_LEVEL_GROUP 8 -#define LEVELINFO_TOKEN_READONLY 9 + closedir(dir); -#define NUM_LEVELINFO_TOKENS 10 + /* special case: top level directory may directly contain "levelinfo.conf" */ + if (node_parent == NULL && !valid_entry_found) + { + /* check if this directory directly contains a file "levelinfo.conf" */ + valid_entry_found |= LoadLevelInfoFromLevelConf(node_first, node_parent, + level_directory, "."); + } -static struct LevelDirInfo ldi; + if (!valid_entry_found) + Error(ERR_WARN, "cannot find any valid level series in directory '%s'", + level_directory); +} -static struct TokenInfo levelinfo_tokens[] = +boolean AdjustGraphicsForEMC() { - /* level directory info */ - { TYPE_STRING, &ldi.name, "name" }, - { TYPE_STRING, &ldi.name_short, "name_short" }, - { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, - { TYPE_STRING, &ldi.author, "author" }, - { TYPE_STRING, &ldi.imported_from, "imported_from" }, - { TYPE_INTEGER, &ldi.levels, "levels" }, - { TYPE_INTEGER, &ldi.first_level, "first_level" }, - { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, - { TYPE_BOOLEAN, &ldi.level_group, "level_group" }, - { TYPE_BOOLEAN, &ldi.readonly, "readonly" } -}; + boolean settings_changed = FALSE; -static void setLevelDirInfoToDefaults(struct LevelDirInfo *ldi) -{ - ldi->filename = NULL; - ldi->fullpath = NULL; - ldi->basepath = NULL; - ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->name_short = NULL; - ldi->name_sorting = NULL; - ldi->author = getStringCopy(ANONYMOUS_NAME); - ldi->imported_from = NULL; - ldi->levels = 0; - ldi->first_level = 0; - ldi->last_level = 0; - ldi->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ - ldi->level_group = FALSE; - ldi->parent_link = FALSE; - ldi->user_defined = FALSE; - ldi->readonly = TRUE; - ldi->color = 0; - ldi->class_desc = NULL; - ldi->handicap_level = 0; - ldi->cl_first = -1; - ldi->cl_cursor = -1; +#if 1 + printf("::: AdjustGraphicsForEMC()\n"); + + settings_changed |= adjustTreeGraphics(leveldir_first_all); + settings_changed |= adjustTreeGraphics(leveldir_first); + + if (leveldir_current) + printf("::: X -> '%s'\n", leveldir_current->graphics_set); + else + printf("::: X (leveldir_current == NULL)\n"); +#endif - ldi->node_parent = NULL; - ldi->node_group = NULL; - ldi->next = NULL; + return settings_changed; } -static void setLevelDirInfoToDefaultsFromParent(struct LevelDirInfo *ldi, - struct LevelDirInfo *parent) +void LoadLevelInfo() { - if (parent == NULL) - { - setLevelDirInfoToDefaults(ldi); - return; - } + InitUserLevelDirectory(getLoginName()); - /* first copy all values from the parent structure ... */ - *ldi = *parent; + DrawInitText("Loading level series:", 120, FC_GREEN); - /* ... then set all fields to default that cannot be inherited from parent. - This is especially important for all those fields that can be set from - the 'levelinfo.conf' config file, because the function 'setSetupInfo()' - calls 'free()' for all already set token values which requires that no - other structure's pointer may point to them! - */ + LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory); + LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir(NULL)); + +#if 1 + /* after loading all level set information, clone the level directory tree + and remove all level sets without levels (these may still contain artwork + to be offered in the setup menu as "custom artwork", and are therefore + checked for existing artwork in the function "LoadLevelArtworkInfo()") */ + leveldir_first_all = leveldir_first; + cloneTree(&leveldir_first, leveldir_first_all, TRUE); +#endif - ldi->filename = NULL; - ldi->fullpath = NULL; - ldi->basepath = NULL; - ldi->name = getStringCopy(ANONYMOUS_NAME); - ldi->name_short = NULL; - ldi->name_sorting = NULL; - ldi->author = getStringCopy(parent->author); - ldi->imported_from = getStringCopy(parent->imported_from); + AdjustGraphicsForEMC(); - ldi->level_group = FALSE; - ldi->parent_link = FALSE; + /* before sorting, the first entries will be from the user directory */ + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); - ldi->node_parent = parent; - ldi->node_group = NULL; - ldi->next = NULL; + if (leveldir_first == NULL) + Error(ERR_EXIT, "cannot find any valid level series in any directory"); + + sortTreeInfo(&leveldir_first, compareTreeInfoEntries); + +#if 0 + dumpTreeInfo(leveldir_first, 0); +#endif } -void setSetupInfo(struct TokenInfo *token_info, - int token_nr, char *token_value) +static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, + TreeInfo *node_parent, + char *base_directory, + char *directory_name, int type) { - int token_type = token_info[token_nr].type; - void *setup_value = token_info[token_nr].value; + char *directory_path = getPath2(base_directory, directory_name); + char *filename = getPath2(directory_path, ARTWORKINFO_FILENAME(type)); + SetupFileHash *setup_file_hash = NULL; + TreeInfo *artwork_new = NULL; + int i; - if (token_value == NULL) - return; +#if 0 + printf("::: CHECKING FOR CONFIG FILE '%s'\n", filename); +#endif - /* set setup field to corresponding token value */ - switch (token_type) + if (fileExists(filename)) + setup_file_hash = loadSetupFileHash(filename); + + if (setup_file_hash == NULL) /* no config file -- look for artwork files */ { - case TYPE_BOOLEAN: - case TYPE_SWITCH: - *(boolean *)setup_value = get_string_boolean_value(token_value); - break; + DIR *dir; + struct dirent *dir_entry; + boolean valid_file_found = FALSE; - case TYPE_KEY: - *(Key *)setup_value = getKeyFromX11KeyName(token_value); - break; + if ((dir = opendir(directory_path)) != NULL) + { + while ((dir_entry = readdir(dir)) != NULL) + { + char *entry_name = dir_entry->d_name; - case TYPE_INTEGER: - *(int *)setup_value = get_string_integer_value(token_value); - break; + if (FileIsArtworkType(entry_name, type)) + { + valid_file_found = TRUE; + break; + } + } - case TYPE_STRING: - if (*(char **)setup_value != NULL) - free(*(char **)setup_value); - *(char **)setup_value = getStringCopy(token_value); - break; + closedir(dir); + } - default: - break; + if (!valid_file_found) + { + if (strcmp(directory_name, ".") != 0) + Error(ERR_WARN, "ignoring artwork directory '%s'", directory_path); + + free(directory_path); + free(filename); + + return FALSE; + } } -} -static int compareLevelDirInfoEntries(const void *object1, const void *object2) -{ - const struct LevelDirInfo *entry1 = *((struct LevelDirInfo **)object1); - const struct LevelDirInfo *entry2 = *((struct LevelDirInfo **)object2); - int compare_result; + artwork_new = newTreeInfo(); - if (entry1->parent_link || entry2->parent_link) - compare_result = (entry1->parent_link ? -1 : +1); - else if (entry1->sort_priority == entry2->sort_priority) + if (node_parent) + setTreeInfoToDefaultsFromParent(artwork_new, node_parent); + else + setTreeInfoToDefaults(artwork_new, type); + + artwork_new->subdir = getStringCopy(directory_name); + + if (setup_file_hash) /* (before defining ".color" and ".class_desc") */ { - char *name1 = getStringToLower(entry1->name_sorting); - char *name2 = getStringToLower(entry2->name_sorting); +#if 0 + checkSetupFileHashIdentifier(setup_file_hash, filename, getCookie("...")); +#endif - compare_result = strcmp(name1, name2); + /* set all structure fields according to the token/value pairs */ + ldi = *artwork_new; + for (i = 0; i < NUM_LEVELINFO_TOKENS; i++) + setSetupInfo(levelinfo_tokens, i, + getHashEntry(setup_file_hash, levelinfo_tokens[i].text)); + *artwork_new = ldi; - free(name1); - free(name2); + if (strcmp(artwork_new->name, ANONYMOUS_NAME) == 0) + setString(&artwork_new->name, artwork_new->subdir); + +#if 0 + DrawInitText(artwork_new->name, 150, FC_YELLOW); +#endif + + if (artwork_new->identifier == NULL) + artwork_new->identifier = getStringCopy(artwork_new->subdir); + + if (artwork_new->name_sorting == NULL) + artwork_new->name_sorting = getStringCopy(artwork_new->name); } - else if (LEVELSORTING(entry1) == LEVELSORTING(entry2)) - compare_result = entry1->sort_priority - entry2->sort_priority; - else - compare_result = LEVELSORTING(entry1) - LEVELSORTING(entry2); - return compare_result; -} + if (node_parent == NULL) /* top level group */ + { + artwork_new->basepath = getStringCopy(base_directory); + artwork_new->fullpath = getStringCopy(artwork_new->subdir); + } + else /* sub level group */ + { + artwork_new->basepath = getStringCopy(node_parent->basepath); + artwork_new->fullpath = getPath2(node_parent->fullpath, directory_name); + } -static void createParentLevelDirNode(struct LevelDirInfo *node_parent) -{ - struct LevelDirInfo *leveldir_new = newLevelDirInfo(); + artwork_new->in_user_dir = + (strcmp(artwork_new->basepath, OPTIONS_ARTWORK_DIRECTORY(type)) != 0); + + /* (may use ".sort_priority" from "setup_file_hash" above) */ + artwork_new->color = ARTWORKCOLOR(artwork_new); + + setString(&artwork_new->class_desc, getLevelClassDescription(artwork_new)); - setLevelDirInfoToDefaults(leveldir_new); + if (setup_file_hash == NULL) /* (after determining ".user_defined") */ + { + if (strcmp(artwork_new->subdir, ".") == 0) + { + if (artwork_new->user_defined) + { + setString(&artwork_new->identifier, "private"); + artwork_new->sort_priority = ARTWORKCLASS_PRIVATE; + } + else + { + setString(&artwork_new->identifier, "classic"); + artwork_new->sort_priority = ARTWORKCLASS_CLASSICS; + } + + /* set to new values after changing ".sort_priority" */ + artwork_new->color = ARTWORKCOLOR(artwork_new); + + setString(&artwork_new->class_desc, + getLevelClassDescription(artwork_new)); + } + else + { + setString(&artwork_new->identifier, artwork_new->subdir); + } - leveldir_new->node_parent = node_parent; - leveldir_new->parent_link = TRUE; + setString(&artwork_new->name, artwork_new->identifier); + setString(&artwork_new->name_sorting, artwork_new->name); + } + + DrawInitText(artwork_new->name, 150, FC_YELLOW); - leveldir_new->name = ".. (parent directory)"; - leveldir_new->name_short = getStringCopy(leveldir_new->name); - leveldir_new->name_sorting = getStringCopy(leveldir_new->name); + pushTreeInfo(node_first, artwork_new); - leveldir_new->filename = ".."; - leveldir_new->fullpath = getStringCopy(node_parent->fullpath); + freeSetupFileHash(setup_file_hash); - leveldir_new->sort_priority = node_parent->sort_priority; - leveldir_new->class_desc = getLevelClassDescription(leveldir_new); + free(directory_path); + free(filename); - pushLevelDirInfo(&node_parent->node_group, leveldir_new); + return TRUE; } -static void LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, - struct LevelDirInfo *node_parent, - char *level_directory) +static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, + TreeInfo *node_parent, + char *base_directory, int type) { DIR *dir; struct dirent *dir_entry; boolean valid_entry_found = FALSE; - if ((dir = opendir(level_directory)) == NULL) +#if 0 + printf("::: CHECKING BASE DIR '%s'\n", base_directory); +#endif + + if ((dir = opendir(base_directory)) == NULL) { - Error(ERR_WARN, "cannot read level directory '%s'", level_directory); + /* display error if directory is main "options.graphics_directory" etc. */ + if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type)) + Error(ERR_WARN, "cannot read directory '%s'", base_directory); + return; } while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */ { - struct SetupFileList *setup_file_list = NULL; struct stat file_status; char *directory_name = dir_entry->d_name; - char *directory_path = getPath2(level_directory, directory_name); - char *filename = NULL; + char *directory_path = getPath2(base_directory, directory_name); - /* skip entries for current and parent directory */ + /* skip directory entries for current and parent directory */ if (strcmp(directory_name, ".") == 0 || strcmp(directory_name, "..") == 0) { @@ -1151,7 +2453,7 @@ static void LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, continue; } - /* find out if directory entry is itself a directory */ + /* skip directory entries which are not a directory or are not accessible */ if (stat(directory_path, &file_status) != 0 || /* cannot stat file */ (file_status.st_mode & S_IFMT) != S_IFDIR) /* not a directory */ { @@ -1159,115 +2461,272 @@ static void LoadLevelInfoFromLevelDir(struct LevelDirInfo **node_first, continue; } - filename = getPath2(directory_path, LEVELINFO_FILENAME); - setup_file_list = loadSetupFileList(filename); + free(directory_path); - if (setup_file_list) - { - struct LevelDirInfo *leveldir_new = newLevelDirInfo(); - int i; + /* check if this directory contains artwork with or without config file */ + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent, + base_directory, + directory_name, type); + } + + closedir(dir); - checkSetupFileListIdentifier(setup_file_list, getCookie("LEVELINFO")); - setLevelDirInfoToDefaultsFromParent(leveldir_new, node_parent); + /* check if this directory directly contains artwork itself */ + valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent, + base_directory, ".", + type); + if (!valid_entry_found) + Error(ERR_WARN, "cannot find any valid artwork in directory '%s'", + base_directory); +} - /* set all structure fields according to the token/value pairs */ - ldi = *leveldir_new; - for (i=0; iname, 150, FC_YELLOW); + setTreeInfoToDefaults(artwork_new, type); - if (leveldir_new->name_short == NULL) - leveldir_new->name_short = getStringCopy(leveldir_new->name); + setString(&artwork_new->subdir, UNDEFINED_FILENAME); + setString(&artwork_new->fullpath, UNDEFINED_FILENAME); + setString(&artwork_new->basepath, UNDEFINED_FILENAME); - if (leveldir_new->name_sorting == NULL) - leveldir_new->name_sorting = getStringCopy(leveldir_new->name); + setString(&artwork_new->identifier, UNDEFINED_FILENAME); + setString(&artwork_new->name, UNDEFINED_FILENAME); + setString(&artwork_new->name_sorting, UNDEFINED_FILENAME); - leveldir_new->filename = getStringCopy(directory_name); + return artwork_new; +} - if (node_parent == NULL) /* top level group */ - { - leveldir_new->basepath = level_directory; - leveldir_new->fullpath = leveldir_new->filename; - } - else /* sub level group */ - { - leveldir_new->basepath = node_parent->basepath; - leveldir_new->fullpath = getPath2(node_parent->fullpath, - directory_name); - } +void LoadArtworkInfo() +{ + DrawInitText("Looking for custom artwork:", 120, FC_GREEN); + + LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL, + options.graphics_directory, + TREE_TYPE_GRAPHICS_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.gfx_first, NULL, + getUserGraphicsDir(), + TREE_TYPE_GRAPHICS_DIR); + + LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL, + options.sounds_directory, + TREE_TYPE_SOUNDS_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.snd_first, NULL, + getUserSoundsDir(), + TREE_TYPE_SOUNDS_DIR); + + LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL, + options.music_directory, + TREE_TYPE_MUSIC_DIR); + LoadArtworkInfoFromArtworkDir(&artwork.mus_first, NULL, + getUserMusicDir(), + TREE_TYPE_MUSIC_DIR); + + if (artwork.gfx_first == NULL) + artwork.gfx_first = getDummyArtworkInfo(TREE_TYPE_GRAPHICS_DIR); + if (artwork.snd_first == NULL) + artwork.snd_first = getDummyArtworkInfo(TREE_TYPE_SOUNDS_DIR); + if (artwork.mus_first == NULL) + artwork.mus_first = getDummyArtworkInfo(TREE_TYPE_MUSIC_DIR); + + /* before sorting, the first entries will be from the user directory */ + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); + if (artwork.gfx_current == NULL) + artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); + + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); + if (artwork.snd_current == NULL) + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); + if (artwork.mus_current == NULL) + artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); + + artwork.gfx_current_identifier = artwork.gfx_current->identifier; + artwork.snd_current_identifier = artwork.snd_current->identifier; + artwork.mus_current_identifier = artwork.mus_current->identifier; + +#if 0 + printf("graphics set == %s\n\n", artwork.gfx_current_identifier); + printf("sounds set == %s\n\n", artwork.snd_current_identifier); + printf("music set == %s\n\n", artwork.mus_current_identifier); +#endif + + sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.mus_first, compareTreeInfoEntries); + +#if 0 + dumpTreeInfo(artwork.gfx_first, 0); + dumpTreeInfo(artwork.snd_first, 0); + dumpTreeInfo(artwork.mus_first, 0); +#endif +} - if (leveldir_new->levels < 1) - leveldir_new->levels = 1; +void LoadArtworkInfoFromLevelNode(ArtworkDirTree **artwork_node, + LevelDirTree *level_node, + char *artwork_directory) +{ + TreeInfo *topnode_last = *artwork_node; + char *path = getPath2(getLevelDirFromTreeInfo(level_node), artwork_directory); + +#if 1 + printf("::: CHECKING '%s' ...\n", path); +#endif + + LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path,(*artwork_node)->type); - leveldir_new->last_level = - leveldir_new->first_level + leveldir_new->levels - 1; + if (topnode_last != *artwork_node) + { + free((*artwork_node)->identifier); + free((*artwork_node)->name); + free((*artwork_node)->name_sorting); + + (*artwork_node)->identifier = getStringCopy(level_node->subdir); + (*artwork_node)->name = getStringCopy(level_node->name); + (*artwork_node)->name_sorting = getStringCopy(level_node->name); + + (*artwork_node)->sort_priority = level_node->sort_priority; + (*artwork_node)->color = LEVELCOLOR((*artwork_node)); + } - leveldir_new->user_defined = - (leveldir_new->basepath == options.level_directory ? FALSE : TRUE); + free(path); +} - leveldir_new->color = LEVELCOLOR(leveldir_new); - leveldir_new->class_desc = getLevelClassDescription(leveldir_new); +void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node, + LevelDirTree *level_node) +{ + /* recursively check all level directories for artwork sub-directories */ - leveldir_new->handicap_level = /* set handicap to default value */ - (leveldir_new->user_defined ? - leveldir_new->last_level : - leveldir_new->first_level); + while (level_node) + { + /* check all tree entries for artwork, but skip parent link entries */ + if (!level_node->parent_link) + { +#if 1 + struct + { + int type; + char *dir; + } + artwork_type_dirs[] = + { + { ARTWORK_TYPE_GRAPHICS, GRAPHICS_DIRECTORY }, + { ARTWORK_TYPE_GRAPHICS, GRAPHICS_ECS_DIRECTORY }, + { ARTWORK_TYPE_GRAPHICS, GRAPHICS_AGA_DIRECTORY }, + { ARTWORK_TYPE_SOUNDS, SOUNDS_DIRECTORY }, + { ARTWORK_TYPE_MUSIC, MUSIC_DIRECTORY }, + { -1, NULL } + }; + int i; - pushLevelDirInfo(node_first, leveldir_new); + for (i = 0; artwork_type_dirs[i].type != -1; i++) + if ((*artwork_node)->type == artwork_type_dirs[i].type) + LoadArtworkInfoFromLevelNode(artwork_node, level_node, + artwork_type_dirs[i].dir); +#else + TreeInfo *topnode_last = *artwork_node; + char *path = getPath2(getLevelDirFromTreeInfo(level_node), + ARTWORK_DIRECTORY((*artwork_node)->type)); - freeSetupFileList(setup_file_list); - valid_entry_found = TRUE; + LoadArtworkInfoFromArtworkDir(artwork_node, NULL, path, + (*artwork_node)->type); - if (leveldir_new->level_group) + if (topnode_last != *artwork_node) { - /* create node to link back to current level directory */ - createParentLevelDirNode(leveldir_new); + free((*artwork_node)->identifier); + free((*artwork_node)->name); + free((*artwork_node)->name_sorting); + + (*artwork_node)->identifier = getStringCopy(level_node->subdir); + (*artwork_node)->name = getStringCopy(level_node->name); + (*artwork_node)->name_sorting = getStringCopy(level_node->name); - /* step into sub-directory and look for more level series */ - LoadLevelInfoFromLevelDir(&leveldir_new->node_group, - leveldir_new, directory_path); + (*artwork_node)->sort_priority = level_node->sort_priority; + (*artwork_node)->color = LEVELCOLOR((*artwork_node)); } - } - else - Error(ERR_WARN, "ignoring level directory '%s'", directory_path); - free(directory_path); - free(filename); - } + free(path); +#endif + } - closedir(dir); + if (level_node->node_group != NULL) + LoadArtworkInfoFromLevelInfo(artwork_node, level_node->node_group); - if (!valid_entry_found) - Error(ERR_WARN, "cannot find any valid level series in directory '%s'", - level_directory); + level_node = level_node->next; + } } -void LoadLevelInfo() +void LoadLevelArtworkInfo() { - InitUserLevelDirectory(getLoginName()); + DrawInitText("Looking for custom level artwork:", 120, FC_GREEN); - DrawInitText("Loading level series:", 120, FC_GREEN); + LoadArtworkInfoFromLevelInfo(&artwork.gfx_first, leveldir_first_all); + LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first_all); + LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first_all); - LoadLevelInfoFromLevelDir(&leveldir_first, NULL, options.level_directory); - LoadLevelInfoFromLevelDir(&leveldir_first, NULL, getUserLevelDir("")); + /* needed for reloading level artwork not known at ealier stage */ - leveldir_current = getFirstValidLevelSeries(leveldir_first); + if (strcmp(artwork.gfx_current_identifier, setup.graphics_set) != 0) + { + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); + if (artwork.gfx_current == NULL) + artwork.gfx_current = + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); + if (artwork.gfx_current == NULL) + artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); + } - if (leveldir_first == NULL) - Error(ERR_EXIT, "cannot find any valid level series in any directory"); + if (strcmp(artwork.snd_current_identifier, setup.sounds_set) != 0) + { + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); + if (artwork.snd_current == NULL) + artwork.snd_current = + getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + if (artwork.snd_current == NULL) + artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); + } - sortLevelDirInfo(&leveldir_first, compareLevelDirInfoEntries); + if (strcmp(artwork.mus_current_identifier, setup.music_set) != 0) + { + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); + if (artwork.mus_current == NULL) + artwork.mus_current = + getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); + if (artwork.mus_current == NULL) + artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); + } + + sortTreeInfo(&artwork.gfx_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.snd_first, compareTreeInfoEntries); + sortTreeInfo(&artwork.mus_first, compareTreeInfoEntries); #if 0 - dumpLevelDirInfo(leveldir_first, 0); + dumpTreeInfo(artwork.gfx_first, 0); + dumpTreeInfo(artwork.snd_first, 0); + dumpTreeInfo(artwork.mus_first, 0); #endif } static void SaveUserLevelInfo() { + LevelDirTree *level_info; char *filename; FILE *file; int i; @@ -1281,120 +2740,161 @@ static void SaveUserLevelInfo() return; } + level_info = newTreeInfo(); + /* always start with reliable default values */ - setLevelDirInfoToDefaults(&ldi); + setTreeInfoToDefaults(level_info, TREE_TYPE_LEVEL_DIR); - ldi.name = getLoginName(); - ldi.author = getRealName(); - ldi.levels = 100; - ldi.first_level = 1; - ldi.sort_priority = LEVELCLASS_USER_START; - ldi.readonly = FALSE; + setString(&level_info->name, getLoginName()); + setString(&level_info->author, getRealName()); + level_info->levels = 100; + level_info->first_level = 1; + + token_value_position = TOKEN_VALUE_POSITION_SHORT; fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, getCookie("LEVELINFO"))); - for (i=0; i/levelsetup.conf */ /* ----------------------------------------------------------------------- */ - filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + SetupFileHash *level_setup_hash = NULL; - if ((level_setup_list = loadSetupFileList(filename))) + /* always start with reliable default values */ + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); + + if ((level_setup_hash = loadSetupFileHash(filename))) { char *last_level_series = - getTokenValue(level_setup_list, TOKEN_STR_LAST_LEVEL_SERIES); + getHashEntry(level_setup_hash, TOKEN_STR_LAST_LEVEL_SERIES); - leveldir_current = getLevelDirInfoFromFilename(last_level_series); + leveldir_current = getTreeInfoFromIdentifier(leveldir_first, + last_level_series); if (leveldir_current == NULL) - leveldir_current = leveldir_first; + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); - checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP")); + checkSetupFileHashIdentifier(level_setup_hash, filename, + getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values"); @@ -1404,17 +2904,15 @@ void LoadLevelSetup_LastSeries() void SaveLevelSetup_LastSeries() { - char *filename; - char *level_subdir = leveldir_current->filename; - FILE *file; - /* ----------------------------------------------------------------------- */ /* ~/./levelsetup.conf */ /* ----------------------------------------------------------------------- */ - InitUserDataDirectory(); + char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + char *level_subdir = leveldir_current->subdir; + FILE *file; - filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); + InitUserDataDirectory(); if (!(file = fopen(filename, MODE_WRITE))) { @@ -1429,9 +2927,10 @@ void SaveLevelSetup_LastSeries() level_subdir)); fclose(file); - free(filename); SetFilePermissions(filename, PERMS_PRIVATE); + + free(filename); } static void checkSeriesInfo() @@ -1442,8 +2941,8 @@ static void checkSeriesInfo() /* check for more levels besides the 'levels' field of 'levelinfo.conf' */ - level_directory = getPath2((leveldir_current->user_defined ? - getUserLevelDir("") : + level_directory = getPath2((leveldir_current->in_user_dir ? + getUserLevelDir(NULL) : options.level_directory), leveldir_current->fullpath); @@ -1467,6 +2966,7 @@ static void checkSeriesInfo() levelnum_value = atoi(levelnum_str); +#if 0 if (levelnum_value < leveldir_current->first_level) { Error(ERR_WARN, "additional level %d found", levelnum_value); @@ -1477,6 +2977,7 @@ static void checkSeriesInfo() Error(ERR_WARN, "additional level %d found", levelnum_value); leveldir_current->last_level = levelnum_value; } +#endif } } @@ -1486,8 +2987,8 @@ static void checkSeriesInfo() void LoadLevelSetup_SeriesInfo() { char *filename; - struct SetupFileList *level_setup_list = NULL; - char *level_subdir = leveldir_current->filename; + SetupFileHash *level_setup_hash = NULL; + char *level_subdir = leveldir_current->subdir; /* always start with reliable default values */ level_nr = leveldir_current->first_level; @@ -1498,15 +2999,15 @@ void LoadLevelSetup_SeriesInfo() /* ~/./levelsetup//levelsetup.conf */ /* ----------------------------------------------------------------------- */ - level_subdir = leveldir_current->filename; + level_subdir = leveldir_current->subdir; filename = getPath2(getLevelSetupDir(level_subdir), LEVELSETUP_FILENAME); - if ((level_setup_list = loadSetupFileList(filename))) + if ((level_setup_hash = loadSetupFileHash(filename))) { char *token_value; - token_value = getTokenValue(level_setup_list, TOKEN_STR_LAST_PLAYED_LEVEL); + token_value = getHashEntry(level_setup_hash, TOKEN_STR_LAST_PLAYED_LEVEL); if (token_value) { @@ -1518,7 +3019,7 @@ void LoadLevelSetup_SeriesInfo() level_nr = leveldir_current->last_level; } - token_value = getTokenValue(level_setup_list, TOKEN_STR_HANDICAP_LEVEL); + token_value = getHashEntry(level_setup_hash, TOKEN_STR_HANDICAP_LEVEL); if (token_value) { @@ -1529,15 +3030,16 @@ void LoadLevelSetup_SeriesInfo() if (level_nr > leveldir_current->last_level + 1) level_nr = leveldir_current->last_level; - if (leveldir_current->user_defined) + if (leveldir_current->user_defined || !leveldir_current->handicap) level_nr = leveldir_current->last_level; leveldir_current->handicap_level = level_nr; } - checkSetupFileListIdentifier(level_setup_list, getCookie("LEVELSETUP")); + checkSetupFileHashIdentifier(level_setup_hash, filename, + getCookie("LEVELSETUP")); - freeSetupFileList(level_setup_list); + freeSetupFileHash(level_setup_hash); } else Error(ERR_WARN, "using default setup values"); @@ -1548,7 +3050,7 @@ void LoadLevelSetup_SeriesInfo() void SaveLevelSetup_SeriesInfo() { char *filename; - char *level_subdir = leveldir_current->filename; + char *level_subdir = leveldir_current->subdir; char *level_nr_str = int2str(level_nr, 0); char *handicap_level_str = int2str(leveldir_current->handicap_level, 0); FILE *file; @@ -1576,7 +3078,8 @@ void SaveLevelSetup_SeriesInfo() handicap_level_str)); fclose(file); - free(filename); SetFilePermissions(filename, PERMS_PRIVATE); + + free(filename); }