X-Git-Url: https://git.artsoft.org/?p=rocksndiamonds.git;a=blobdiff_plain;f=src%2Flibgame%2Fsetup.c;h=aa97093c5669144986d4746b8de9f0e66daf0e2e;hp=9df2b53ec2ffe04eadbaafddcdd9634efd2074d6;hb=1c527635393b7bc090eb9833f302b329f8aacd23;hpb=462bca0782be497b984922afda26b5bf12bd3d75 diff --git a/src/libgame/setup.c b/src/libgame/setup.c index 9df2b53e..aa97093c 100644 --- a/src/libgame/setup.c +++ b/src/libgame/setup.c @@ -1,21 +1,20 @@ -/*********************************************************** -* Artsoft Retro-Game Library * -*----------------------------------------------------------* -* (c) 1994-2006 Artsoft Entertainment * -* Holger Schemel * -* Detmolder Strasse 189 * -* 33604 Bielefeld * -* Germany * -* e-mail: info@artsoft.org * -*----------------------------------------------------------* -* setup.c * -***********************************************************/ +// ============================================================================ +// Artsoft Retro-Game Library +// ---------------------------------------------------------------------------- +// (c) 1995-2014 by Artsoft Entertainment +// Holger Schemel +// info@artsoft.org +// http://www.artsoft.org/ +// ---------------------------------------------------------------------------- +// setup.c +// ============================================================================ #include #include #include #include #include +#include #include "platform.h" @@ -31,6 +30,8 @@ #include "hash.h" +#define ENABLE_UNUSED_CODE FALSE /* for currently unused functions */ + #define NUM_LEVELCLASS_DESC 8 static char *levelclass_desc[NUM_LEVELCLASS_DESC] = @@ -88,6 +89,7 @@ static char *levelclass_desc[NUM_LEVELCLASS_DESC] = static void setTreeInfoToDefaults(TreeInfo *, int); +static TreeInfo *getTreeInfoCopy(TreeInfo *ti); static int compareTreeInfoEntries(const void *, const void *); static int token_value_position = TOKEN_VALUE_POSITION_DEFAULT; @@ -261,14 +263,14 @@ static char *getDefaultMusicDir(char *music_subdir) return music_dir; } -static char *getDefaultArtworkSet(int type) +static char *getClassicArtworkSet(int type) { 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 : ""); } -static char *getDefaultArtworkDir(int type) +static char *getClassicArtworkDir(int type) { return (type == TREE_TYPE_GRAPHICS_DIR ? getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR) : @@ -312,6 +314,9 @@ static char *getSetupArtworkDir(TreeInfo *ti) { static char *artwork_dir = NULL; + if (ti == NULL) + return NULL; + checked_free(artwork_dir); artwork_dir = getPath2(ti->basepath, ti->fullpath); @@ -333,24 +338,32 @@ char *setLevelArtworkDir(TreeInfo *ti) checked_free(*artwork_path_ptr); if ((level_artwork = getTreeInfoFromIdentifier(ti, *artwork_set_ptr))) + { *artwork_path_ptr = getStringCopy(getSetupArtworkDir(level_artwork)); + } else { - /* 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. */ + /* + 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. + + Update: For "special" versions of R'n'D (like "R'n'D jue"), do not use + the "default" artwork (which would be "jue0" for "R'n'D jue"), but use + the real "classic" artwork from the original R'n'D (like "gfx_classic"). + */ char *dir = getPath2(getCurrentLevelDir(), ARTWORK_DIRECTORY(ti->type)); checked_free(*artwork_set_ptr); - if (fileExists(dir)) + if (directoryExists(dir)) { - *artwork_path_ptr = getStringCopy(getDefaultArtworkDir(ti->type)); - *artwork_set_ptr = getStringCopy(getDefaultArtworkSet(ti->type)); + *artwork_path_ptr = getStringCopy(getClassicArtworkDir(ti->type)); + *artwork_set_ptr = getStringCopy(getClassicArtworkSet(ti->type)); } else { @@ -403,6 +416,19 @@ char *getSolutionTapeFilename(int nr) sprintf(basename, "%03d.%s", nr, TAPEFILE_EXTENSION); filename = getPath2(getSolutionTapeDir(), basename); + if (!fileExists(filename)) + { + static char *filename_sln = NULL; + + checked_free(filename_sln); + + sprintf(basename, "%03d.sln", nr); + filename_sln = getPath2(getSolutionTapeDir(), basename); + + if (fileExists(filename_sln)) + return filename_sln; + } + return filename; } @@ -497,65 +523,85 @@ char *getLevelSetInfoFilename() return NULL; } -char *getLevelSetMessageFilename() +char *getLevelSetTitleMessageBasename(int nr, boolean initial) +{ + static char basename[32]; + + sprintf(basename, "%s_%d.txt", + (initial ? "titlemessage_initial" : "titlemessage"), nr + 1); + + return basename; +} + +char *getLevelSetTitleMessageFilename(int nr, boolean initial) { static char *filename = NULL; - char *basenames[] = - { - "MESSAGE", - "MESSAGE.TXT", - "MESSAGE.txt", - "Message", - "Message.txt", - "message", - "message.txt", + char *basename; + boolean skip_setup_artwork = FALSE; - NULL - }; - int i; + checked_free(filename); - for (i = 0; basenames[i] != NULL; i++) + basename = getLevelSetTitleMessageBasename(nr, initial); + + if (!gfx.override_level_graphics) { - checked_free(filename); - filename = getPath2(getCurrentLevelDir(), basenames[i]); + /* 1st try: look for special artwork in current level series directory */ + filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); + if (fileExists(filename)) + return filename; + free(filename); + + /* 2nd try: look for message file in current level set directory */ + filename = getPath2(getCurrentLevelDir(), basename); if (fileExists(filename)) return filename; - } - return NULL; -} + free(filename); -static char *getCorrectedArtworkBasename(char *basename) -{ - char *basename_corrected = basename; + /* check if there is special artwork configured in level series config */ + if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL) + { + /* 3rd try: look for special artwork configured in level series config */ + filename = getPath2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename); + if (fileExists(filename)) + return filename; + + free(filename); + + /* take missing artwork configured in level set config from default */ + skip_setup_artwork = TRUE; + } + } -#if defined(PLATFORM_MSDOS) - if (program.filename_prefix != NULL) + if (!skip_setup_artwork) { - int prefix_len = strlen(program.filename_prefix); + /* 4th try: look for special artwork in configured artwork directory */ + filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename); + if (fileExists(filename)) + return filename; - if (strncmp(basename, program.filename_prefix, prefix_len) == 0) - basename_corrected = &basename[prefix_len]; + free(filename); + } - /* 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; + /* 5th try: look for default artwork in new default artwork directory */ + filename = getPath2(getDefaultGraphicsDir(GFX_DEFAULT_SUBDIR), basename); + if (fileExists(filename)) + return filename; - checked_free(msdos_filename); + free(filename); - msdos_filename = getStringCopy(basename_corrected); - strncpy(&msdos_filename[8], &basename[strlen(basename) - (1+3)], 1+3 +1); + /* 6th try: look for default artwork in old default artwork directory */ + filename = getPath2(options.graphics_directory, basename); + if (fileExists(filename)) + return filename; - basename_corrected = msdos_filename; - } - } -#endif + return NULL; /* cannot find specified artwork file anywhere */ +} - return basename_corrected; +static char *getCorrectedArtworkBasename(char *basename) +{ + return basename; } char *getCustomImageFilename(char *basename) @@ -567,10 +613,10 @@ char *getCustomImageFilename(char *basename) basename = getCorrectedArtworkBasename(basename); - if (!setup.override_level_graphics) + if (!gfx.override_level_graphics) { /* 1st try: look for special artwork in current level series directory */ - filename = getPath3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); + filename = getImg3(getCurrentLevelDir(), GRAPHICS_DIRECTORY, basename); if (fileExists(filename)) return filename; @@ -580,7 +626,7 @@ char *getCustomImageFilename(char *basename) if (getLevelArtworkSet(ARTWORK_TYPE_GRAPHICS) != NULL) { /* 2nd try: look for special artwork configured in level series config */ - filename = getPath2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename); + filename = getImg2(getLevelArtworkDir(ARTWORK_TYPE_GRAPHICS), basename); if (fileExists(filename)) return filename; @@ -594,7 +640,7 @@ char *getCustomImageFilename(char *basename) if (!skip_setup_artwork) { /* 3rd try: look for special artwork in configured artwork directory */ - filename = getPath2(getSetupArtworkDir(artwork.gfx_current), basename); + filename = getImg2(getSetupArtworkDir(artwork.gfx_current), basename); if (fileExists(filename)) return filename; @@ -602,17 +648,30 @@ char *getCustomImageFilename(char *basename) } /* 4th try: look for default artwork in new default artwork directory */ - filename = getPath2(getDefaultGraphicsDir(GFX_CLASSIC_SUBDIR), basename); + filename = getImg2(getDefaultGraphicsDir(GFX_DEFAULT_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); + filename = getImg2(options.graphics_directory, basename); if (fileExists(filename)) return filename; +#if defined(CREATE_SPECIAL_EDITION) + free(filename); + + if (options.debug) + Error(ERR_WARN, "cannot find artwork file '%s' (using fallback)", basename); + + /* 6th try: look for fallback artwork in old default artwork directory */ + /* (needed to prevent errors when trying to access unused artwork files) */ + filename = getImg2(options.graphics_directory, GFX_FALLBACK_FILENAME); + if (fileExists(filename)) + return filename; +#endif + return NULL; /* cannot find specified artwork file anywhere */ } @@ -625,7 +684,7 @@ char *getCustomSoundFilename(char *basename) basename = getCorrectedArtworkBasename(basename); - if (!setup.override_level_sounds) + if (!gfx.override_level_sounds) { /* 1st try: look for special artwork in current level series directory */ filename = getPath3(getCurrentLevelDir(), SOUNDS_DIRECTORY, basename); @@ -660,7 +719,7 @@ char *getCustomSoundFilename(char *basename) } /* 4th try: look for default artwork in new default artwork directory */ - filename = getPath2(getDefaultSoundsDir(SND_CLASSIC_SUBDIR), basename); + filename = getPath2(getDefaultSoundsDir(SND_DEFAULT_SUBDIR), basename); if (fileExists(filename)) return filename; @@ -671,6 +730,19 @@ char *getCustomSoundFilename(char *basename) if (fileExists(filename)) return filename; +#if defined(CREATE_SPECIAL_EDITION) + free(filename); + + if (options.debug) + Error(ERR_WARN, "cannot find artwork file '%s' (using fallback)", basename); + + /* 6th try: look for fallback artwork in old default artwork directory */ + /* (needed to prevent errors when trying to access unused artwork files) */ + filename = getPath2(options.sounds_directory, SND_FALLBACK_FILENAME); + if (fileExists(filename)) + return filename; +#endif + return NULL; /* cannot find specified artwork file anywhere */ } @@ -683,7 +755,7 @@ char *getCustomMusicFilename(char *basename) basename = getCorrectedArtworkBasename(basename); - if (!setup.override_level_music) + if (!gfx.override_level_music) { /* 1st try: look for special artwork in current level series directory */ filename = getPath3(getCurrentLevelDir(), MUSIC_DIRECTORY, basename); @@ -718,7 +790,7 @@ char *getCustomMusicFilename(char *basename) } /* 4th try: look for default artwork in new default artwork directory */ - filename = getPath2(getDefaultMusicDir(MUS_CLASSIC_SUBDIR), basename); + filename = getPath2(getDefaultMusicDir(MUS_DEFAULT_SUBDIR), basename); if (fileExists(filename)) return filename; @@ -729,6 +801,19 @@ char *getCustomMusicFilename(char *basename) if (fileExists(filename)) return filename; +#if defined(CREATE_SPECIAL_EDITION) + free(filename); + + if (options.debug) + Error(ERR_WARN, "cannot find artwork file '%s' (using fallback)", basename); + + /* 6th try: look for fallback artwork in old default artwork directory */ + /* (needed to prevent errors when trying to access unused artwork files) */ + filename = getPath2(options.music_directory, MUS_FALLBACK_FILENAME); + if (fileExists(filename)) + return filename; +#endif + return NULL; /* cannot find specified artwork file anywhere */ } @@ -767,11 +852,11 @@ char *getCustomMusicDirectory(void) checked_free(directory); - if (!setup.override_level_music) + if (!gfx.override_level_music) { /* 1st try: look for special artwork in current level series directory */ directory = getPath2(getCurrentLevelDir(), MUSIC_DIRECTORY); - if (fileExists(directory)) + if (directoryExists(directory)) return directory; free(directory); @@ -781,7 +866,7 @@ char *getCustomMusicDirectory(void) { /* 2nd try: look for special artwork configured in level series config */ directory = getStringCopy(getLevelArtworkDir(TREE_TYPE_MUSIC_DIR)); - if (fileExists(directory)) + if (directoryExists(directory)) return directory; free(directory); @@ -795,22 +880,22 @@ char *getCustomMusicDirectory(void) { /* 3rd try: look for special artwork in configured artwork directory */ directory = getStringCopy(getSetupArtworkDir(artwork.mus_current)); - if (fileExists(directory)) + if (directoryExists(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)) + directory = getStringCopy(getDefaultMusicDir(MUS_DEFAULT_SUBDIR)); + if (directoryExists(directory)) return directory; free(directory); /* 5th try: look for default artwork in old default artwork directory */ directory = getStringCopy(options.music_directory); - if (fileExists(directory)) + if (directoryExists(directory)) return directory; return NULL; /* cannot find specified artwork file anywhere */ @@ -834,7 +919,7 @@ static void SaveUserLevelInfo(); void InitUserLevelDirectory(char *level_subdir) { - if (!fileExists(getUserLevelDir(level_subdir))) + if (!directoryExists(getUserLevelDir(level_subdir))) { createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE); createDirectory(getUserLevelDir(NULL), "main user level", PERMS_PRIVATE); @@ -1009,9 +1094,7 @@ TreeInfo *cloneTreeNode(TreeInfo **node_top, TreeInfo *node_parent, return cloneTreeNode(node_top, node_parent, node->next, skip_sets_without_levels); - node_new = newTreeInfo(); - - *node_new = *node; /* copy complete node */ + node_new = getTreeInfoCopy(node); /* copy complete node */ node_new->node_top = node_top; /* correct top node link */ node_new->node_parent = node_parent; /* correct parent node link */ @@ -1072,8 +1155,13 @@ void dumpTreeInfo(TreeInfo *node, int depth) for (i = 0; i < (depth + 1) * 3; i++) printf(" "); + printf("'%s' / '%s'\n", node->identifier, node->name); + + /* + // use for dumping artwork info tree 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); @@ -1257,9 +1345,14 @@ char *getUserGameDataDir(void) { static char *user_game_data_dir = NULL; +#if defined(PLATFORM_ANDROID) + if (user_game_data_dir == NULL) + user_game_data_dir = (char *)SDL_AndroidGetInternalStoragePath(); +#else if (user_game_data_dir == NULL) user_game_data_dir = getPath2(getPersonalDataDir(), program.userdata_subdir); +#endif return user_game_data_dir; } @@ -1271,7 +1364,7 @@ void updateUserGameDataDir() char *userdata_dir_new = getUserGameDataDir(); /* do not free() this */ /* convert old Unix style game data directory to Mac OS X style, if needed */ - if (fileExists(userdata_dir_old) && !fileExists(userdata_dir_new)) + if (directoryExists(userdata_dir_old) && !directoryExists(userdata_dir_new)) { if (rename(userdata_dir_old, userdata_dir_new) != 0) { @@ -1311,21 +1404,42 @@ static int posix_mkdir(const char *pathname, mode_t mode) #endif } +static boolean posix_process_running_setgid() +{ +#if defined(PLATFORM_UNIX) + return (getgid() != getegid()); +#else + return FALSE; +#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 last_umask = posix_umask(0); mode_t group_umask = ~(dir_mode & S_IRWXG); - posix_umask(normal_umask & group_umask); + int running_setgid = posix_process_running_setgid(); + + /* if we're setgid, protect files against "other" */ + /* else keep umask(0) to make the dir world-writable */ + + if (running_setgid) + posix_umask(last_umask & group_umask); + else + dir_mode |= MODE_W_ALL; - if (!fileExists(dir)) + if (!directoryExists(dir)) if (posix_mkdir(dir, dir_mode) != 0) - Error(ERR_WARN, "cannot create %s directory '%s'", text, dir); + Error(ERR_WARN, "cannot create %s directory '%s': %s", + text, dir, strerror(errno)); - posix_umask(normal_umask); /* reset normal umask */ + if (permission_class == PERMS_PUBLIC && !running_setgid) + chmod(dir, dir_mode); + + posix_umask(last_umask); /* restore previous umask */ } void InitUserDataDirectory() @@ -1335,8 +1449,14 @@ void InitUserDataDirectory() void SetFilePermissions(char *filename, int permission_class) { - chmod(filename, (permission_class == PERMS_PRIVATE ? - FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC)); + int running_setgid = posix_process_running_setgid(); + int perms = (permission_class == PERMS_PRIVATE ? + FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC); + + if (permission_class == PERMS_PUBLIC && !running_setgid) + perms |= MODE_W_ALL; + + chmod(filename, perms); } char *getCookie(char *file_type) @@ -1354,6 +1474,17 @@ char *getCookie(char *file_type) return cookie; } +void fprintFileHeader(FILE *file, char *basename) +{ + char *prefix = "# "; + char *sep1 = "="; + + fprintf_line_with_prefix(file, prefix, sep1, 77); + fprintf(file, "%s%s\n", prefix, basename); + fprintf_line_with_prefix(file, prefix, sep1, 77); + fprintf(file, "\n"); +} + int getFileVersionFromCookieString(const char *cookie) { const char *ptr_cookie1, *ptr_cookie2; @@ -1401,6 +1532,7 @@ boolean checkCookieString(const char *cookie, const char *template) return TRUE; } + /* ------------------------------------------------------------------------- */ /* setup file list and hash handling functions */ /* ------------------------------------------------------------------------- */ @@ -1492,6 +1624,7 @@ SetupFileList *addListEntry(SetupFileList *list, char *token, char *value) return addListEntry(list->next, token, value); } +#if ENABLE_UNUSED_CODE #ifdef DEBUG static void printSetupFileList(SetupFileList *list) { @@ -1504,6 +1637,7 @@ static void printSetupFileList(SetupFileList *list) printSetupFileList(list->next); } #endif +#endif #ifdef DEBUG DEFINE_HASHTABLE_INSERT(insert_hash_entry, char, char); @@ -1517,7 +1651,7 @@ DEFINE_HASHTABLE_REMOVE(remove_hash_entry, char, char); #define remove_hash_entry hashtable_remove #endif -static unsigned int get_hash_from_key(void *key) +unsigned int get_hash_from_key(void *key) { /* djb2 @@ -1602,7 +1736,8 @@ char *removeHashEntry(SetupFileHash *hash, char *token) return remove_hash_entry(hash, token); } -#if 0 +#if ENABLE_UNUSED_CODE +#if DEBUG static void printSetupFileHash(SetupFileHash *hash) { BEGIN_HASH_ITERATION(hash, itr) @@ -1613,45 +1748,212 @@ static void printSetupFileHash(SetupFileHash *hash) END_HASH_ITERATION(hash, itr) } #endif +#endif + +#define ALLOW_TOKEN_VALUE_SEPARATOR_BEING_WHITESPACE 1 +#define CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING 0 +#define CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH 0 + +static boolean token_value_separator_found = FALSE; +#if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING +static boolean token_value_separator_warning = FALSE; +#endif +#if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH +static boolean token_already_exists_warning = FALSE; +#endif + +static boolean getTokenValueFromSetupLineExt(char *line, + char **token_ptr, char **value_ptr, + char *filename, char *line_raw, + int line_nr, + boolean separator_required) +{ + static char line_copy[MAX_LINE_LEN + 1], line_raw_copy[MAX_LINE_LEN + 1]; + char *token, *value, *line_ptr; + + /* when externally invoked via ReadTokenValueFromLine(), copy line buffers */ + if (line_raw == NULL) + { + strncpy(line_copy, line, MAX_LINE_LEN); + line_copy[MAX_LINE_LEN] = '\0'; + line = line_copy; + + strcpy(line_raw_copy, line_copy); + line_raw = line_raw_copy; + } + + /* 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') + return FALSE; + + /* cut leading whitespaces from token */ + for (token = line; *token; token++) + if (*token != ' ' && *token != '\t') + break; + + /* start with empty value as reliable default */ + value = ""; + + token_value_separator_found = FALSE; + + /* find end of token to determine start of value */ + for (line_ptr = token; *line_ptr; line_ptr++) + { + /* first look for an explicit token/value separator, like ':' or '=' */ + if (*line_ptr == ':' || *line_ptr == '=') + { + *line_ptr = '\0'; /* terminate token string */ + value = line_ptr + 1; /* set beginning of value */ + + token_value_separator_found = TRUE; + + break; + } + } + +#if ALLOW_TOKEN_VALUE_SEPARATOR_BEING_WHITESPACE + /* fallback: if no token/value separator found, also allow whitespaces */ + if (!token_value_separator_found && !separator_required) + { + for (line_ptr = token; *line_ptr; line_ptr++) + { + if (*line_ptr == ' ' || *line_ptr == '\t') + { + *line_ptr = '\0'; /* terminate token string */ + value = line_ptr + 1; /* set beginning of value */ + + token_value_separator_found = TRUE; + + break; + } + } + +#if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING + if (token_value_separator_found) + { + if (!token_value_separator_warning) + { + Error(ERR_INFO_LINE, "-"); + + if (filename != NULL) + { + Error(ERR_WARN, "missing token/value separator(s) in config file:"); + Error(ERR_INFO, "- config file: '%s'", filename); + } + else + { + Error(ERR_WARN, "missing token/value separator(s):"); + } + + token_value_separator_warning = TRUE; + } + + if (filename != NULL) + Error(ERR_INFO, "- line %d: '%s'", line_nr, line_raw); + else + Error(ERR_INFO, "- line: '%s'", line_raw); + } +#endif + } +#endif + + /* cut trailing whitespaces from token */ + for (line_ptr = &token[strlen(token)]; line_ptr >= token; line_ptr--) + if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0') + *line_ptr = '\0'; + + /* cut leading whitespaces from value */ + for (; *value; value++) + if (*value != ' ' && *value != '\t') + break; -static void *loadSetupFileData(char *filename, boolean use_hash) + *token_ptr = token; + *value_ptr = value; + + return TRUE; +} + +boolean getTokenValueFromSetupLine(char *line, char **token, char **value) { - char line[MAX_LINE_LEN], previous_line[MAX_LINE_LEN]; + /* while the internal (old) interface does not require a token/value + separator (for downwards compatibility with existing files which + don't use them), it is mandatory for the external (new) interface */ + + return getTokenValueFromSetupLineExt(line, token, value, NULL, NULL, 0, TRUE); +} + +static boolean loadSetupFileData(void *setup_file_data, char *filename, + boolean top_recursion_level, boolean is_hash) +{ + static SetupFileHash *include_filename_hash = NULL; + char line[MAX_LINE_LEN], line_raw[MAX_LINE_LEN], previous_line[MAX_LINE_LEN]; char *token, *value, *line_ptr; - void *setup_file_data, *insert_ptr = NULL; + void *insert_ptr = NULL; boolean read_continued_line = FALSE; - FILE *file; + File *file; + int line_nr = 0, token_count = 0, include_count = 0; + +#if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING + token_value_separator_warning = FALSE; +#endif + +#if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH + token_already_exists_warning = FALSE; +#endif - if (!(file = fopen(filename, MODE_READ))) + if (!(file = openFile(filename, MODE_READ))) { Error(ERR_WARN, "cannot open configuration file '%s'", filename); - return NULL; + return FALSE; } - if (use_hash) - setup_file_data = newSetupFileHash(); - else - insert_ptr = setup_file_data = newSetupFileList("", ""); + /* use "insert pointer" to store list end for constant insertion complexity */ + if (!is_hash) + insert_ptr = setup_file_data; + + /* on top invocation, create hash to mark included files (to prevent loops) */ + if (top_recursion_level) + include_filename_hash = newSetupFileHash(); - while (!feof(file)) + /* mark this file as already included (to prevent including it again) */ + setHashEntry(include_filename_hash, getBaseNamePtr(filename), "true"); + + while (!checkEndOfFile(file)) { /* read next line of input file */ - if (!fgets(line, MAX_LINE_LEN, file)) + if (!getStringFromFile(file, line, MAX_LINE_LEN)) break; - /* cut trailing newline or carriage return */ + /* check if line was completely read and is terminated by line break */ + if (strlen(line) > 0 && line[strlen(line) - 1] == '\n') + line_nr++; + + /* cut trailing line break (this can be newline and/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'; + /* copy raw input line for later use (mainly debugging output) */ + strcpy(line_raw, line); + 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); @@ -1672,95 +1974,89 @@ static void *loadSetupFileData(char *filename, boolean use_hash) 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') + if (!getTokenValueFromSetupLineExt(line, &token, &value, filename, + line_raw, line_nr, FALSE)) 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 (*token) { -#if 1 - if (*line_ptr == ':' || *line_ptr == '=') -#else - if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':') -#endif + if (strEqual(token, "include")) { - *line_ptr = '\0'; /* terminate token string */ - value = line_ptr + 1; /* set beginning of value */ + if (getHashEntry(include_filename_hash, value) == NULL) + { + char *basepath = getBasePath(filename); + char *basename = getBaseName(value); + char *filename_include = getPath2(basepath, basename); - break; - } - } + loadSetupFileData(setup_file_data, filename_include, FALSE, is_hash); - /* cut trailing whitespaces from token */ - for (line_ptr = &token[strlen(token)]; line_ptr >= token; line_ptr--) - if ((*line_ptr == ' ' || *line_ptr == '\t') && *(line_ptr + 1) == '\0') - *line_ptr = '\0'; + free(basepath); + free(basename); + free(filename_include); - /* 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" */ + include_count++; + } + else + { + Error(ERR_WARN, "ignoring already processed file '%s'", value); + } + } + else + { + if (is_hash) + { +#if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH + char *old_value = + getHashEntry((SetupFileHash *)setup_file_data, token); + + if (old_value != NULL) + { + if (!token_already_exists_warning) + { + Error(ERR_INFO_LINE, "-"); + Error(ERR_WARN, "duplicate token(s) found in config file:"); + Error(ERR_INFO, "- config file: '%s'", filename); + + token_already_exists_warning = TRUE; + } + + Error(ERR_INFO, "- token: '%s' (in line %d)", token, line_nr); + Error(ERR_INFO, " old value: '%s'", old_value); + Error(ERR_INFO, " new value: '%s'", value); + } #endif - if (*token) - { - if (use_hash) - setHashEntry((SetupFileHash *)setup_file_data, token, value); - else - insert_ptr = addListEntry((SetupFileList *)insert_ptr, token, value); + setHashEntry((SetupFileHash *)setup_file_data, token, value); + } + else + { + insert_ptr = addListEntry((SetupFileList *)insert_ptr, token, value); + } + + token_count++; + } } } - fclose(file); + closeFile(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; +#if CHECK_TOKEN_VALUE_SEPARATOR__WARN_IF_MISSING + if (token_value_separator_warning) + Error(ERR_INFO_LINE, "-"); +#endif - /* free empty list header */ - setup_file_list->next = NULL; - freeSetupFileList(setup_file_list); - setup_file_data = first_valid_list_entry; +#if CHECK_TOKEN__WARN_IF_ALREADY_EXISTS_IN_HASH + if (token_already_exists_warning) + Error(ERR_INFO_LINE, "-"); +#endif - if (first_valid_list_entry == NULL) - Error(ERR_WARN, "configuration file '%s' is empty", filename); - } + if (token_count == 0 && include_count == 0) + Error(ERR_WARN, "configuration file '%s' is empty", filename); + + if (top_recursion_level) + freeSetupFileHash(include_filename_hash); - return setup_file_data; + return TRUE; } void saveSetupFileHash(SetupFileHash *hash, char *filename) @@ -1786,23 +2082,37 @@ void saveSetupFileHash(SetupFileHash *hash, char *filename) SetupFileList *loadSetupFileList(char *filename) { - return (SetupFileList *)loadSetupFileData(filename, FALSE); + SetupFileList *setup_file_list = newSetupFileList("", ""); + SetupFileList *first_valid_list_entry; + + if (!loadSetupFileData(setup_file_list, filename, TRUE, FALSE)) + { + freeSetupFileList(setup_file_list); + + return NULL; + } + + first_valid_list_entry = setup_file_list->next; + + /* free empty list header */ + setup_file_list->next = NULL; + freeSetupFileList(setup_file_list); + + return first_valid_list_entry; } SetupFileHash *loadSetupFileHash(char *filename) { - return (SetupFileHash *)loadSetupFileData(filename, TRUE); -} + SetupFileHash *setup_file_hash = newSetupFileHash(); -void checkSetupFileHashIdentifier(SetupFileHash *setup_file_hash, - char *filename, char *identifier) -{ - char *value = getHashEntry(setup_file_hash, TOKEN_STR_FILE_IDENTIFIER); + if (!loadSetupFileData(setup_file_hash, filename, TRUE, TRUE)) + { + freeSetupFileHash(setup_file_hash); - 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); + return NULL; + } + + return setup_file_hash; } @@ -1819,25 +2129,28 @@ void checkSetupFileHashIdentifier(SetupFileHash *setup_file_hash, #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_SET_ECS 12 -#define LEVELINFO_TOKEN_GRAPHICS_SET_AGA 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 +#define LEVELINFO_TOKEN_YEAR 4 +#define LEVELINFO_TOKEN_IMPORTED_FROM 5 +#define LEVELINFO_TOKEN_IMPORTED_BY 6 +#define LEVELINFO_TOKEN_TESTED_BY 7 +#define LEVELINFO_TOKEN_LEVELS 8 +#define LEVELINFO_TOKEN_FIRST_LEVEL 9 +#define LEVELINFO_TOKEN_SORT_PRIORITY 10 +#define LEVELINFO_TOKEN_LATEST_ENGINE 11 +#define LEVELINFO_TOKEN_LEVEL_GROUP 12 +#define LEVELINFO_TOKEN_READONLY 13 +#define LEVELINFO_TOKEN_GRAPHICS_SET_ECS 14 +#define LEVELINFO_TOKEN_GRAPHICS_SET_AGA 15 +#define LEVELINFO_TOKEN_GRAPHICS_SET 16 +#define LEVELINFO_TOKEN_SOUNDS_SET 17 +#define LEVELINFO_TOKEN_MUSIC_SET 18 +#define LEVELINFO_TOKEN_FILENAME 19 +#define LEVELINFO_TOKEN_FILETYPE 20 +#define LEVELINFO_TOKEN_SPECIAL_FLAGS 21 +#define LEVELINFO_TOKEN_HANDICAP 22 +#define LEVELINFO_TOKEN_SKIP_LEVELS 23 + +#define NUM_LEVELINFO_TOKENS 24 static LevelDirTree ldi; @@ -1848,8 +2161,10 @@ static struct TokenInfo levelinfo_tokens[] = { TYPE_STRING, &ldi.name, "name" }, { TYPE_STRING, &ldi.name_sorting, "name_sorting" }, { TYPE_STRING, &ldi.author, "author" }, + { TYPE_STRING, &ldi.year, "year" }, { TYPE_STRING, &ldi.imported_from, "imported_from" }, { TYPE_STRING, &ldi.imported_by, "imported_by" }, + { TYPE_STRING, &ldi.tested_by, "tested_by" }, { TYPE_INTEGER, &ldi.levels, "levels" }, { TYPE_INTEGER, &ldi.first_level, "first_level" }, { TYPE_INTEGER, &ldi.sort_priority, "sort_priority" }, @@ -1863,6 +2178,7 @@ static struct TokenInfo levelinfo_tokens[] = { TYPE_STRING, &ldi.music_set, "music_set" }, { TYPE_STRING, &ldi.level_filename, "filename" }, { TYPE_STRING, &ldi.level_filetype, "filetype" }, + { TYPE_STRING, &ldi.special_flags, "special_flags" }, { TYPE_BOOLEAN, &ldi.handicap, "handicap" }, { TYPE_BOOLEAN, &ldi.skip_levels, "skip_levels" } }; @@ -1909,6 +2225,7 @@ static void setTreeInfoToDefaults(TreeInfo *ti, int type) ti->name = getStringCopy(ANONYMOUS_NAME); ti->name_sorting = NULL; ti->author = getStringCopy(ANONYMOUS_NAME); + ti->year = NULL; ti->sort_priority = LEVELCLASS_UNDEFINED; /* default: least priority */ ti->latest_engine = FALSE; /* default: get from level */ @@ -1924,6 +2241,7 @@ static void setTreeInfoToDefaults(TreeInfo *ti, int type) { ti->imported_from = NULL; ti->imported_by = NULL; + ti->tested_by = NULL; ti->graphics_set_ecs = NULL; ti->graphics_set_aga = NULL; @@ -1937,6 +2255,8 @@ static void setTreeInfoToDefaults(TreeInfo *ti, int type) ti->level_filename = NULL; ti->level_filetype = NULL; + ti->special_flags = NULL; + ti->levels = 0; ti->first_level = 0; ti->last_level = 0; @@ -1978,6 +2298,7 @@ static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent) ti->name = getStringCopy(ANONYMOUS_NAME); ti->name_sorting = NULL; ti->author = getStringCopy(parent->author); + ti->year = getStringCopy(parent->year); ti->sort_priority = parent->sort_priority; ti->latest_engine = parent->latest_engine; @@ -1993,6 +2314,7 @@ static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent) { ti->imported_from = getStringCopy(parent->imported_from); ti->imported_by = getStringCopy(parent->imported_by); + ti->tested_by = getStringCopy(parent->tested_by); ti->graphics_set_ecs = NULL; ti->graphics_set_aga = NULL; @@ -2006,18 +2328,86 @@ static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent) ti->level_filename = NULL; ti->level_filetype = NULL; + ti->special_flags = getStringCopy(parent->special_flags); + ti->levels = 0; ti->first_level = 0; ti->last_level = 0; ti->level_group = FALSE; ti->handicap_level = 0; - ti->readonly = TRUE; + ti->readonly = parent->readonly; ti->handicap = TRUE; ti->skip_levels = FALSE; } } -static void freeTreeInfo(TreeInfo *ti) +static TreeInfo *getTreeInfoCopy(TreeInfo *ti) +{ + TreeInfo *ti_copy = newTreeInfo(); + + /* copy all values from the original structure */ + + ti_copy->type = ti->type; + + ti_copy->node_top = ti->node_top; + ti_copy->node_parent = ti->node_parent; + ti_copy->node_group = ti->node_group; + ti_copy->next = ti->next; + + ti_copy->cl_first = ti->cl_first; + ti_copy->cl_cursor = ti->cl_cursor; + + ti_copy->subdir = getStringCopy(ti->subdir); + ti_copy->fullpath = getStringCopy(ti->fullpath); + ti_copy->basepath = getStringCopy(ti->basepath); + ti_copy->identifier = getStringCopy(ti->identifier); + ti_copy->name = getStringCopy(ti->name); + ti_copy->name_sorting = getStringCopy(ti->name_sorting); + ti_copy->author = getStringCopy(ti->author); + ti_copy->year = getStringCopy(ti->year); + ti_copy->imported_from = getStringCopy(ti->imported_from); + ti_copy->imported_by = getStringCopy(ti->imported_by); + ti_copy->tested_by = getStringCopy(ti->tested_by); + + ti_copy->graphics_set_ecs = getStringCopy(ti->graphics_set_ecs); + ti_copy->graphics_set_aga = getStringCopy(ti->graphics_set_aga); + ti_copy->graphics_set = getStringCopy(ti->graphics_set); + ti_copy->sounds_set = getStringCopy(ti->sounds_set); + ti_copy->music_set = getStringCopy(ti->music_set); + ti_copy->graphics_path = getStringCopy(ti->graphics_path); + ti_copy->sounds_path = getStringCopy(ti->sounds_path); + ti_copy->music_path = getStringCopy(ti->music_path); + + ti_copy->level_filename = getStringCopy(ti->level_filename); + ti_copy->level_filetype = getStringCopy(ti->level_filetype); + + ti_copy->special_flags = getStringCopy(ti->special_flags); + + ti_copy->levels = ti->levels; + ti_copy->first_level = ti->first_level; + ti_copy->last_level = ti->last_level; + ti_copy->sort_priority = ti->sort_priority; + + ti_copy->latest_engine = ti->latest_engine; + + ti_copy->level_group = ti->level_group; + ti_copy->parent_link = ti->parent_link; + ti_copy->in_user_dir = ti->in_user_dir; + ti_copy->user_defined = ti->user_defined; + ti_copy->readonly = ti->readonly; + ti_copy->handicap = ti->handicap; + ti_copy->skip_levels = ti->skip_levels; + + ti_copy->color = ti->color; + ti_copy->class_desc = getStringCopy(ti->class_desc); + ti_copy->handicap_level = ti->handicap_level; + + ti_copy->infotext = getStringCopy(ti->infotext); + + return ti_copy; +} + +void freeTreeInfo(TreeInfo *ti) { if (ti == NULL) return; @@ -2030,6 +2420,7 @@ static void freeTreeInfo(TreeInfo *ti) checked_free(ti->name); checked_free(ti->name_sorting); checked_free(ti->author); + checked_free(ti->year); checked_free(ti->class_desc); @@ -2039,6 +2430,7 @@ static void freeTreeInfo(TreeInfo *ti) { checked_free(ti->imported_from); checked_free(ti->imported_by); + checked_free(ti->tested_by); checked_free(ti->graphics_set_ecs); checked_free(ti->graphics_set_aga); @@ -2052,8 +2444,18 @@ static void freeTreeInfo(TreeInfo *ti) checked_free(ti->level_filename); checked_free(ti->level_filetype); + + checked_free(ti->special_flags); } + // recursively free child node + if (ti->node_group) + freeTreeInfo(ti->node_group); + + // recursively free next node + if (ti->next) + freeTreeInfo(ti->next); + checked_free(ti); } @@ -2074,6 +2476,10 @@ void setSetupInfo(struct TokenInfo *token_info, *(boolean *)setup_value = get_boolean_from_string(token_value); break; + case TYPE_SWITCH3: + *(int *)setup_value = get_switch3_from_string(token_value); + break; + case TYPE_KEY: *(Key *)setup_value = getKeyFromKeyName(token_value); break; @@ -2100,7 +2506,7 @@ static int compareTreeInfoEntries(const void *object1, const void *object2) { const TreeInfo *entry1 = *((TreeInfo **)object1); const TreeInfo *entry2 = *((TreeInfo **)object2); - int class_sorting1, class_sorting2; + int class_sorting1 = 0, class_sorting2 = 0; int compare_result; if (entry1->type == TREE_TYPE_LEVEL_DIR) @@ -2108,7 +2514,9 @@ static int compareTreeInfoEntries(const void *object1, const void *object2) class_sorting1 = LEVELSORTING(entry1); class_sorting2 = LEVELSORTING(entry2); } - else + else if (entry1->type == TREE_TYPE_GRAPHICS_DIR || + entry1->type == TREE_TYPE_SOUNDS_DIR || + entry1->type == TREE_TYPE_MUSIC_DIR) { class_sorting1 = ARTWORKSORTING(entry1); class_sorting2 = ARTWORKSORTING(entry2); @@ -2223,14 +2631,9 @@ static char *getCacheToken(char *prefix, char *suffix) return token; } -static char *getFileTimestamp(char *filename) +static char *getFileTimestampString(char *filename) { - struct stat file_status; - - if (stat(filename, &file_status) != 0) /* cannot stat file */ - return getStringCopy(i_to_a(0)); - - return getStringCopy(i_to_a(file_status.st_mtime)); + return getStringCopy(i_to_a(getFileTimestampEpochSeconds(filename))); } static boolean modifiedFileTimestamp(char *filename, char *timestamp_string) @@ -2278,13 +2681,12 @@ static TreeInfo *getArtworkInfoCacheEntry(LevelDirTree *level_node, int type) /* check if cache entry for this item is invalid or incomplete */ if (value == NULL) { -#if 1 - printf("::: - WARNING: cache entry '%s' invalid\n", token); -#endif + Error(ERR_WARN, "cache entry '%s' invalid", token); cached = FALSE; } } + *artwork_info = ldi; } @@ -2309,11 +2711,6 @@ static TreeInfo *getArtworkInfoCacheEntry(LevelDirTree *level_node, int type) if (modifiedFileTimestamp(filename_artworkinfo, cache_entry)) cached = FALSE; -#if 0 - if (!cached) - printf("::: '%s': INVALIDATED FROM CACHE BY TIMESTAMP\n", identifier); -#endif - checked_free(filename_levelinfo); checked_free(filename_artworkinfo); } @@ -2346,8 +2743,8 @@ static void setArtworkInfoCacheEntry(TreeInfo *artwork_info, LEVELINFO_FILENAME); char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info), ARTWORKINFO_FILENAME(type)); - char *timestamp_levelinfo = getFileTimestamp(filename_levelinfo); - char *timestamp_artworkinfo = getFileTimestamp(filename_artworkinfo); + char *timestamp_levelinfo = getFileTimestampString(filename_levelinfo); + char *timestamp_artworkinfo = getFileTimestampString(filename_artworkinfo); token_main = getCacheToken(token_prefix, "TIMESTAMP_LEVELINFO"); setHashEntry(artworkinfo_cache_new, token_main, timestamp_levelinfo); @@ -2421,9 +2818,6 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, leveldir_new->subdir = getStringCopy(directory_name); - checkSetupFileHashIdentifier(setup_file_hash, filename, - getCookie("LEVELINFO")); - /* set all structure fields according to the token/value pairs */ ldi = *leveldir_new; for (i = 0; i < NUM_LEVELINFO_TOKENS; i++) @@ -2451,11 +2845,6 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, leveldir_new->fullpath = getPath2(node_parent->fullpath, directory_name); } -#if 0 - if (leveldir_new->levels < 1) - leveldir_new->levels = 1; -#endif - leveldir_new->last_level = leveldir_new->first_level + leveldir_new->levels - 1; @@ -2484,24 +2873,7 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first, (leveldir_new->user_defined || !leveldir_new->handicap ? leveldir_new->last_level : leveldir_new->first_level); - if (leveldir_new->level_group) - DrawInitText(leveldir_new->name, 150, FC_YELLOW); - -#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); - - return FALSE; - } -#endif -#endif + DrawInitText(leveldir_new->name, 150, FC_YELLOW); pushTreeInfo(node_first, leveldir_new); @@ -2527,20 +2899,20 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, TreeInfo *node_parent, char *level_directory) { - DIR *dir; - struct dirent *dir_entry; + Directory *dir; + DirectoryEntry *dir_entry; boolean valid_entry_found = FALSE; - if ((dir = opendir(level_directory)) == NULL) + if ((dir = openDirectory(level_directory)) == NULL) { Error(ERR_WARN, "cannot read level directory '%s'", level_directory); + return; } - while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */ + while ((dir_entry = readDirectory(dir)) != NULL) /* loop all entries */ { - struct stat file_status; - char *directory_name = dir_entry->d_name; + char *directory_name = dir_entry->basename; char *directory_path = getPath2(level_directory, directory_name); /* skip entries for current and parent directory */ @@ -2548,14 +2920,15 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, strEqual(directory_name, "..")) { free(directory_path); + continue; } /* 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 */ + if (!dir_entry->is_directory) /* not a directory */ { free(directory_path); + continue; } @@ -2571,7 +2944,7 @@ static void LoadLevelInfoFromLevelDir(TreeInfo **node_first, directory_name); } - closedir(dir); + closeDirectory(dir); /* special case: top level directory may directly contain "levelinfo.conf" */ if (node_parent == NULL && !valid_entry_found) @@ -2622,7 +2995,7 @@ void LoadLevelInfo() sortTreeInfo(&leveldir_first); -#if 0 +#if ENABLE_UNUSED_CODE dumpTreeInfo(leveldir_first, 0); #endif } @@ -2643,24 +3016,23 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, if (setup_file_hash == NULL) /* no config file -- look for artwork files */ { - DIR *dir; - struct dirent *dir_entry; + Directory *dir; + DirectoryEntry *dir_entry; boolean valid_file_found = FALSE; - if ((dir = opendir(directory_path)) != NULL) + if ((dir = openDirectory(directory_path)) != NULL) { - while ((dir_entry = readdir(dir)) != NULL) + while ((dir_entry = readDirectory(dir)) != NULL) { - char *entry_name = dir_entry->d_name; - - if (FileIsArtworkType(entry_name, type)) + if (FileIsArtworkType(dir_entry->filename, type)) { valid_file_found = TRUE; + break; } } - closedir(dir); + closeDirectory(dir); } if (!valid_file_found) @@ -2686,10 +3058,6 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, if (setup_file_hash) /* (before defining ".color" and ".class_desc") */ { -#if 0 - checkSetupFileHashIdentifier(setup_file_hash, filename, getCookie("...")); -#endif - /* set all structure fields according to the token/value pairs */ ldi = *artwork_new; for (i = 0; i < NUM_LEVELINFO_TOKENS; i++) @@ -2756,10 +3124,6 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first, setString(&artwork_new->name_sorting, artwork_new->name); } -#if 0 - DrawInitText(artwork_new->name, 150, FC_YELLOW); -#endif - pushTreeInfo(node_first, artwork_new); freeSetupFileHash(setup_file_hash); @@ -2774,11 +3138,11 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, TreeInfo *node_parent, char *base_directory, int type) { - DIR *dir; - struct dirent *dir_entry; + Directory *dir; + DirectoryEntry *dir_entry; boolean valid_entry_found = FALSE; - if ((dir = opendir(base_directory)) == NULL) + if ((dir = openDirectory(base_directory)) == NULL) { /* display error if directory is main "options.graphics_directory" etc. */ if (base_directory == OPTIONS_ARTWORK_DIRECTORY(type)) @@ -2787,10 +3151,9 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, return; } - while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */ + while ((dir_entry = readDirectory(dir)) != NULL) /* loop all entries */ { - struct stat file_status; - char *directory_name = dir_entry->d_name; + char *directory_name = dir_entry->basename; char *directory_path = getPath2(base_directory, directory_name); /* skip directory entries for current and parent directory */ @@ -2798,14 +3161,15 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, strEqual(directory_name, "..")) { free(directory_path); + continue; } - /* 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 */ + /* skip directory entries which are not a directory */ + if (!dir_entry->is_directory) /* not a directory */ { free(directory_path); + continue; } @@ -2817,7 +3181,7 @@ static void LoadArtworkInfoFromArtworkDir(TreeInfo **node_first, directory_name, type); } - closedir(dir); + closeDirectory(dir); /* check if this directory directly contains artwork itself */ valid_entry_found |= LoadArtworkInfoFromArtworkConf(node_first, node_parent, @@ -2885,7 +3249,7 @@ void LoadArtworkInfo() getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); if (artwork.gfx_current == NULL) artwork.gfx_current = - getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_DEFAULT_SUBDIR); if (artwork.gfx_current == NULL) artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); @@ -2893,7 +3257,7 @@ void LoadArtworkInfo() getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); if (artwork.snd_current == NULL) artwork.snd_current = - getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.snd_first, SND_DEFAULT_SUBDIR); if (artwork.snd_current == NULL) artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); @@ -2901,7 +3265,7 @@ void LoadArtworkInfo() getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); if (artwork.mus_current == NULL) artwork.mus_current = - getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.mus_first, MUS_DEFAULT_SUBDIR); if (artwork.mus_current == NULL) artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); @@ -2909,7 +3273,7 @@ void LoadArtworkInfo() artwork.snd_current_identifier = artwork.snd_current->identifier; artwork.mus_current_identifier = artwork.mus_current->identifier; -#if 0 +#if ENABLE_UNUSED_CODE 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); @@ -2919,7 +3283,7 @@ void LoadArtworkInfo() sortTreeInfo(&artwork.snd_first); sortTreeInfo(&artwork.mus_first); -#if 0 +#if ENABLE_UNUSED_CODE dumpTreeInfo(artwork.gfx_first, 0); dumpTreeInfo(artwork.snd_first, 0); dumpTreeInfo(artwork.mus_first, 0); @@ -2973,10 +3337,7 @@ void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node, setArtworkInfoCacheEntry(artwork_new, level_node, type); } -#if 1 - if (level_node->level_group) - DrawInitText(level_node->name, 150, FC_YELLOW); -#endif + DrawInitText(level_node->name, 150, FC_YELLOW); if (level_node->node_group != NULL) LoadArtworkInfoFromLevelInfo(artwork_node, level_node->node_group); @@ -2987,14 +3348,23 @@ void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node, void LoadLevelArtworkInfo() { + print_timestamp_init("LoadLevelArtworkInfo"); + DrawInitText("Looking for custom level artwork", 120, FC_GREEN); + print_timestamp_time("DrawTimeText"); + LoadArtworkInfoFromLevelInfo(&artwork.gfx_first, leveldir_first_all); + print_timestamp_time("LoadArtworkInfoFromLevelInfo (gfx)"); LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first_all); + print_timestamp_time("LoadArtworkInfoFromLevelInfo (snd)"); LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first_all); + print_timestamp_time("LoadArtworkInfoFromLevelInfo (mus)"); SaveArtworkInfoCache(); + print_timestamp_time("SaveArtworkInfoCache"); + /* needed for reloading level artwork not known at ealier stage */ if (!strEqual(artwork.gfx_current_identifier, setup.graphics_set)) @@ -3003,7 +3373,7 @@ void LoadLevelArtworkInfo() getTreeInfoFromIdentifier(artwork.gfx_first, setup.graphics_set); if (artwork.gfx_current == NULL) artwork.gfx_current = - getTreeInfoFromIdentifier(artwork.gfx_first, GFX_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.gfx_first, GFX_DEFAULT_SUBDIR); if (artwork.gfx_current == NULL) artwork.gfx_current = getFirstValidTreeInfoEntry(artwork.gfx_first); } @@ -3014,7 +3384,7 @@ void LoadLevelArtworkInfo() getTreeInfoFromIdentifier(artwork.snd_first, setup.sounds_set); if (artwork.snd_current == NULL) artwork.snd_current = - getTreeInfoFromIdentifier(artwork.snd_first, SND_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.snd_first, SND_DEFAULT_SUBDIR); if (artwork.snd_current == NULL) artwork.snd_current = getFirstValidTreeInfoEntry(artwork.snd_first); } @@ -3025,20 +3395,26 @@ void LoadLevelArtworkInfo() getTreeInfoFromIdentifier(artwork.mus_first, setup.music_set); if (artwork.mus_current == NULL) artwork.mus_current = - getTreeInfoFromIdentifier(artwork.mus_first, MUS_CLASSIC_SUBDIR); + getTreeInfoFromIdentifier(artwork.mus_first, MUS_DEFAULT_SUBDIR); if (artwork.mus_current == NULL) artwork.mus_current = getFirstValidTreeInfoEntry(artwork.mus_first); } + print_timestamp_time("getTreeInfoFromIdentifier"); + sortTreeInfo(&artwork.gfx_first); sortTreeInfo(&artwork.snd_first); sortTreeInfo(&artwork.mus_first); -#if 0 + print_timestamp_time("sortTreeInfo"); + +#if ENABLE_UNUSED_CODE dumpTreeInfo(artwork.gfx_first, 0); dumpTreeInfo(artwork.snd_first, 0); dumpTreeInfo(artwork.mus_first, 0); #endif + + print_timestamp_done("LoadLevelArtworkInfo"); } static void SaveUserLevelInfo() @@ -3069,8 +3445,7 @@ static void SaveUserLevelInfo() token_value_position = TOKEN_VALUE_POSITION_SHORT; - fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, - getCookie("LEVELINFO"))); + fprintFileHeader(file, LEVELINFO_FILENAME); ldi = *level_info; for (i = 0; i < NUM_LEVELINFO_TOKENS; i++) @@ -3113,10 +3488,20 @@ char *getSetupValue(int type, void *value) strcpy(value_string, (*(boolean *)value ? "on" : "off")); break; + case TYPE_SWITCH3: + strcpy(value_string, (*(int *)value == AUTO ? "auto" : + *(int *)value == FALSE ? "off" : "on")); + break; + case TYPE_YES_NO: strcpy(value_string, (*(boolean *)value ? "yes" : "no")); break; + case TYPE_YES_NO_AUTO: + strcpy(value_string, (*(int *)value == AUTO ? "auto" : + *(int *)value == FALSE ? "no" : "yes")); + break; + case TYPE_ECS_AGA: strcpy(value_string, (*(boolean *)value ? "AGA" : "ECS")); break; @@ -3201,6 +3586,13 @@ void LoadLevelSetup_LastSeries() /* always start with reliable default values */ leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); +#if defined(CREATE_SPECIAL_EDITION_RND_JUE) + leveldir_current = getTreeInfoFromIdentifier(leveldir_first, + "jue_start"); + if (leveldir_current == NULL) + leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); +#endif + if ((level_setup_hash = loadSetupFileHash(filename))) { char *last_level_series = @@ -3211,9 +3603,6 @@ void LoadLevelSetup_LastSeries() if (leveldir_current == NULL) leveldir_current = getFirstValidTreeInfoEntry(leveldir_first); - checkSetupFileHashIdentifier(level_setup_hash, filename, - getCookie("LEVELSETUP")); - freeSetupFileHash(level_setup_hash); } else @@ -3222,12 +3611,16 @@ void LoadLevelSetup_LastSeries() free(filename); } -void SaveLevelSetup_LastSeries() +static void SaveLevelSetup_LastSeries_Ext(boolean deactivate_last_level_series) { /* ----------------------------------------------------------------------- */ /* ~/./levelsetup.conf */ /* ----------------------------------------------------------------------- */ + // check if the current level directory structure is available at this point + if (leveldir_current == NULL) + return; + char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME); char *level_subdir = leveldir_current->subdir; FILE *file; @@ -3237,12 +3630,17 @@ void SaveLevelSetup_LastSeries() if (!(file = fopen(filename, MODE_WRITE))) { Error(ERR_WARN, "cannot write setup file '%s'", filename); + free(filename); + return; } - fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, - getCookie("LEVELSETUP"))); + fprintFileHeader(file, LEVELSETUP_FILENAME); + + if (deactivate_last_level_series) + fprintf(file, "# %s\n# ", "the following level set may have caused a problem and was deactivated"); + fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_LAST_LEVEL_SERIES, level_subdir)); @@ -3253,11 +3651,20 @@ void SaveLevelSetup_LastSeries() free(filename); } +void SaveLevelSetup_LastSeries() +{ + SaveLevelSetup_LastSeries_Ext(FALSE); +} + +void SaveLevelSetup_LastSeries_Deactivate() +{ + SaveLevelSetup_LastSeries_Ext(TRUE); +} + static void checkSeriesInfo() { static char *level_directory = NULL; - DIR *dir; - struct dirent *dir_entry; + Directory *dir; /* check for more levels besides the 'levels' field of 'levelinfo.conf' */ @@ -3266,42 +3673,14 @@ static void checkSeriesInfo() options.level_directory), leveldir_current->fullpath); - if ((dir = opendir(level_directory)) == NULL) + if ((dir = openDirectory(level_directory)) == NULL) { Error(ERR_WARN, "cannot read level directory '%s'", level_directory); - return; - } - while ((dir_entry = readdir(dir)) != NULL) /* last directory entry */ - { - if (strlen(dir_entry->d_name) > 4 && - dir_entry->d_name[3] == '.' && - strEqual(&dir_entry->d_name[4], LEVELFILE_EXTENSION)) - { - char levelnum_str[4]; - int levelnum_value; - - strncpy(levelnum_str, dir_entry->d_name, 3); - levelnum_str[3] = '\0'; - - levelnum_value = atoi(levelnum_str); - -#if 0 - if (levelnum_value < leveldir_current->first_level) - { - Error(ERR_WARN, "additional level %d found", levelnum_value); - leveldir_current->first_level = levelnum_value; - } - else if (levelnum_value > leveldir_current->last_level) - { - Error(ERR_WARN, "additional level %d found", levelnum_value); - leveldir_current->last_level = levelnum_value; - } -#endif - } + return; } - closedir(dir); + closeDirectory(dir); } void LoadLevelSetup_SeriesInfo() @@ -3309,10 +3688,17 @@ void LoadLevelSetup_SeriesInfo() char *filename; SetupFileHash *level_setup_hash = NULL; char *level_subdir = leveldir_current->subdir; + int i; /* always start with reliable default values */ level_nr = leveldir_current->first_level; + for (i = 0; i < MAX_LEVELS; i++) + { + LevelStats_setPlayed(i, 0); + LevelStats_setSolved(i, 0); + } + checkSeriesInfo(leveldir_current); /* ----------------------------------------------------------------------- */ @@ -3327,6 +3713,8 @@ void LoadLevelSetup_SeriesInfo() { char *token_value; + /* get last played level in this level set */ + token_value = getHashEntry(level_setup_hash, TOKEN_STR_LAST_PLAYED_LEVEL); if (token_value) @@ -3339,6 +3727,8 @@ void LoadLevelSetup_SeriesInfo() level_nr = leveldir_current->last_level; } + /* get handicap level in this level set */ + token_value = getHashEntry(level_setup_hash, TOKEN_STR_HANDICAP_LEVEL); if (token_value) @@ -3356,8 +3746,30 @@ void LoadLevelSetup_SeriesInfo() leveldir_current->handicap_level = level_nr; } - checkSetupFileHashIdentifier(level_setup_hash, filename, - getCookie("LEVELSETUP")); + /* get number of played and solved levels in this level set */ + + BEGIN_HASH_ITERATION(level_setup_hash, itr) + { + char *token = HASH_ITERATION_TOKEN(itr); + char *value = HASH_ITERATION_VALUE(itr); + + if (strlen(token) == 3 && + token[0] >= '0' && token[0] <= '9' && + token[1] >= '0' && token[1] <= '9' && + token[2] >= '0' && token[2] <= '9') + { + int level_nr = atoi(token); + + if (value != NULL) + LevelStats_setPlayed(level_nr, atoi(value)); /* read 1st column */ + + value = strchr(value, ' '); + + if (value != NULL) + LevelStats_setSolved(level_nr, atoi(value)); /* read 2nd column */ + } + } + END_HASH_ITERATION(hash, itr) freeSetupFileHash(level_setup_hash); } @@ -3374,6 +3786,7 @@ void SaveLevelSetup_SeriesInfo() char *level_nr_str = int2str(level_nr, 0); char *handicap_level_str = int2str(leveldir_current->handicap_level, 0); FILE *file; + int i; /* ----------------------------------------------------------------------- */ /* ~/./levelsetup//levelsetup.conf */ @@ -3390,12 +3803,28 @@ void SaveLevelSetup_SeriesInfo() return; } - fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, - getCookie("LEVELSETUP"))); + fprintFileHeader(file, LEVELSETUP_FILENAME); + fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_LAST_PLAYED_LEVEL, level_nr_str)); - fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_HANDICAP_LEVEL, - handicap_level_str)); + fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_HANDICAP_LEVEL, + handicap_level_str)); + + for (i = leveldir_current->first_level; i <= leveldir_current->last_level; + i++) + { + if (LevelStats_getPlayed(i) > 0 || + LevelStats_getSolved(i) > 0) + { + char token[16]; + char value[16]; + + sprintf(token, "%03d", i); + sprintf(value, "%d %d", LevelStats_getPlayed(i), LevelStats_getSolved(i)); + + fprintf(file, "%s\n", getFormattedSetupEntry(token, value)); + } + } fclose(file); @@ -3403,3 +3832,37 @@ void SaveLevelSetup_SeriesInfo() free(filename); } + +int LevelStats_getPlayed(int nr) +{ + return (nr >= 0 && nr < MAX_LEVELS ? level_stats[nr].played : 0); +} + +int LevelStats_getSolved(int nr) +{ + return (nr >= 0 && nr < MAX_LEVELS ? level_stats[nr].solved : 0); +} + +void LevelStats_setPlayed(int nr, int value) +{ + if (nr >= 0 && nr < MAX_LEVELS) + level_stats[nr].played = value; +} + +void LevelStats_setSolved(int nr, int value) +{ + if (nr >= 0 && nr < MAX_LEVELS) + level_stats[nr].solved = value; +} + +void LevelStats_incPlayed(int nr) +{ + if (nr >= 0 && nr < MAX_LEVELS) + level_stats[nr].played++; +} + +void LevelStats_incSolved(int nr) +{ + if (nr >= 0 && nr < MAX_LEVELS) + level_stats[nr].solved++; +}