Darkvater@4220: /* $Id$ */ Darkvater@4220: belugas@6117: /** @file fios.cpp Darkvater@4220: * This file contains functions for building file lists for the save/load dialogs. Darkvater@4220: */ Darkvater@4220: Darkvater@4220: #include "stdafx.h" Darkvater@4220: #include "openttd.h" Darkvater@4220: #include "variables.h" truelight@4300: #include "heightmap.h" Darkvater@4221: #include "fios.h" rubidium@10039: #include "fileio_func.h" rubidium@8131: #include "functions.h" rubidium@8214: #include "string_func.h" Darkvater@4220: #include Darkvater@4220: #include Darkvater@4220: Darkvater@4220: #ifdef WIN32 Darkvater@6251: # include glx@9139: # ifndef UNICODE glx@9139: # include glx@9139: # endif glx@8378: # define access _taccess glx@8378: # define unlink _tunlink Darkvater@4220: #else Darkvater@4220: # include Darkvater@4220: #endif /* WIN32 */ Darkvater@4220: rubidium@8264: #include "table/strings.h" rubidium@8264: Darkvater@4223: /* Variables to display file lists */ skidd13@9441: SmallVector _fios_items; Darkvater@4223: static char *_fios_path; belugas@8151: SmallFiosItem _file_to_saveload; Darkvater@4220: Darkvater@4221: /* OS-specific functions are taken from their respective files (win32/unix/os2 .c) */ Darkvater@4221: extern bool FiosIsRoot(const char *path); Darkvater@4221: extern bool FiosIsValidFile(const char *path, const struct dirent *ent, struct stat *sb); rubidium@6240: extern bool FiosIsHiddenFile(const struct dirent *ent); rubidium@6247: extern void FiosGetDrives(); Darkvater@4222: extern bool FiosGetDiskFreeSpace(const char *path, uint32 *tot); Darkvater@4221: Darkvater@4221: /* get the name of an oldstyle savegame */ Darkvater@4221: extern void GetOldSaveGameName(char *title, const char *path, const char *file); Darkvater@4221: Darkvater@4220: /** Darkvater@4220: * Compare two FiosItem's. Used with qsort when sorting the file list. Darkvater@4220: * @param a A pointer to the first FiosItem to compare. belugas@6481: * @param b A pointer to the second FiosItem to compare. Darkvater@4220: * @return -1, 0 or 1, depending on how the two items should be sorted. Darkvater@4220: */ Darkvater@4220: int CDECL compare_FiosItems(const void *a, const void *b) Darkvater@4220: { Darkvater@4220: const FiosItem *da = (const FiosItem *)a; Darkvater@4220: const FiosItem *db = (const FiosItem *)b; Darkvater@4220: int r; Darkvater@4220: Darkvater@4220: if (_savegame_sort_order & SORT_BY_NAME) { Darkvater@4220: r = strcasecmp(da->title, db->title); Darkvater@4220: } else { Darkvater@4220: r = da->mtime < db->mtime ? -1 : 1; Darkvater@4220: } Darkvater@4220: Darkvater@4220: if (_savegame_sort_order & SORT_DESCENDING) r = -r; Darkvater@4220: return r; Darkvater@4220: } Darkvater@4220: skidd13@9441: /** Clear the list */ rubidium@6247: void FiosFreeSavegameList() Darkvater@4220: { skidd13@9441: _fios_items.Clear(); skidd13@9441: _fios_items.Compact(); skidd13@9441: }; Darkvater@4220: Darkvater@4222: /** Darkvater@4222: * Get descriptive texts. Returns the path and free space Darkvater@4222: * left on the device Darkvater@4222: * @param path string describing the path Darkvater@4222: * @param total_free total free space in megabytes, optional (can be NULL) Darkvater@4222: * @return StringID describing the path (free space or failure) Darkvater@4222: */ Darkvater@4222: StringID FiosGetDescText(const char **path, uint32 *total_free) Darkvater@4222: { Darkvater@4222: *path = _fios_path; Darkvater@4222: return FiosGetDiskFreeSpace(*path, total_free) ? STR_4005_BYTES_FREE : STR_4006_UNABLE_TO_READ_DRIVE; Darkvater@4222: } Darkvater@4222: Darkvater@4222: /* Browse to a new path based on the passed FiosItem struct Darkvater@4222: * @param *item FiosItem object telling us what to do Darkvater@4222: * @return a string if we have given a file as a target, otherwise NULL */ Darkvater@4222: char *FiosBrowseTo(const FiosItem *item) Darkvater@4222: { Darkvater@4222: char *path = _fios_path; Darkvater@4222: Darkvater@4222: switch (item->type) { glx@9032: case FIOS_TYPE_DRIVE: truelight@7408: #if defined(WINCE) rubidium@10301: snprintf(path, MAX_PATH, PATHSEP ""); truelight@7408: #elif defined(WIN32) || defined(__OS2__) rubidium@10301: snprintf(path, MAX_PATH, "%c:" PATHSEP, item->title[0]); Darkvater@4222: #endif glx@9032: /* Fallthrough */ glx@9032: case FIOS_TYPE_INVALID: glx@9032: break; Darkvater@4222: peter1138@9030: case FIOS_TYPE_PARENT: { peter1138@9030: /* Check for possible NULL ptr (not required for UNIXes, but AmigaOS-alikes) */ peter1138@9030: char *s = strrchr(path, PATHSEPCHAR); peter1138@9030: if (s != NULL && s != path) { peter1138@9030: s[0] = '\0'; // Remove last path separator character, so we can go up one level. peter1138@9030: } peter1138@9030: s = strrchr(path, PATHSEPCHAR); peter1138@9030: if (s != NULL) s[1] = '\0'; // go up a directory peter1138@9030: #if defined(__MORPHOS__) || defined(__AMIGAOS__) peter1138@9030: /* On MorphOS or AmigaOS paths look like: "Volume:directory/subdirectory" */ peter1138@9030: else if ((s = strrchr(path, ':')) != NULL) s[1] = '\0'; peter1138@9030: #endif peter1138@9030: break; Darkvater@4222: } Darkvater@4222: peter1138@9030: case FIOS_TYPE_DIR: peter1138@9030: strcat(path, item->name); peter1138@9030: strcat(path, PATHSEP); peter1138@9030: break; Darkvater@4222: peter1138@9030: case FIOS_TYPE_DIRECT: rubidium@10301: snprintf(path, MAX_PATH, "%s", item->name); peter1138@9030: break; peter1138@9030: peter1138@9030: case FIOS_TYPE_FILE: peter1138@9030: case FIOS_TYPE_OLDFILE: peter1138@9030: case FIOS_TYPE_SCENARIO: peter1138@9030: case FIOS_TYPE_OLD_SCENARIO: peter1138@9030: case FIOS_TYPE_PNG: peter1138@9030: case FIOS_TYPE_BMP: peter1138@9030: { peter1138@9030: static char str_buffr[512]; peter1138@9030: snprintf(str_buffr, lengthof(str_buffr), "%s%s", path, item->name); peter1138@9030: return str_buffr; peter1138@9030: } Darkvater@4222: } Darkvater@4222: Darkvater@4222: return NULL; Darkvater@4222: } Darkvater@4222: Darkvater@4220: void FiosMakeSavegameName(char *buf, const char *name, size_t size) Darkvater@4220: { Darkvater@4220: const char *extension, *period; Darkvater@4220: Darkvater@4220: extension = (_game_mode == GM_EDITOR) ? ".scn" : ".sav"; Darkvater@4220: Darkvater@4220: /* Don't append the extension if it is already there */ Darkvater@4220: period = strrchr(name, '.'); Darkvater@4220: if (period != NULL && strcasecmp(period, extension) == 0) extension = ""; rubidium@7911: #if defined(__MORPHOS__) || defined(__AMIGAOS__) rubidium@7911: if (_fios_path != NULL) { rubidium@7911: unsigned char sepchar = _fios_path[(strlen(_fios_path) - 1)]; Darkvater@4220: rubidium@7911: if (sepchar != ':' && sepchar != '/') { rubidium@7911: snprintf(buf, size, "%s" PATHSEP "%s%s", _fios_path, name, extension); rubidium@7911: } else { rubidium@7911: snprintf(buf, size, "%s%s%s", _fios_path, name, extension); rubidium@7911: } rubidium@7911: } else { rubidium@7911: snprintf(buf, size, "%s%s", name, extension); rubidium@7911: } rubidium@7911: #else Darkvater@4220: snprintf(buf, size, "%s" PATHSEP "%s%s", _fios_path, name, extension); rubidium@7911: #endif Darkvater@4220: } Darkvater@4220: Darkvater@6251: #if defined(WIN32) Darkvater@6251: # define unlink _tunlink Darkvater@5167: #endif Darkvater@5167: Darkvater@4220: bool FiosDelete(const char *name) Darkvater@4220: { Darkvater@4220: char filename[512]; Darkvater@4220: Darkvater@4220: FiosMakeSavegameName(filename, name, lengthof(filename)); Darkvater@5167: return unlink(OTTD2FS(filename)) == 0; Darkvater@4220: } Darkvater@4220: Darkvater@4220: bool FileExists(const char *filename) Darkvater@4220: { truelight@5757: #if defined(WINCE) truelight@5757: /* There is always one platform that doesn't support basic commands... */ Darkvater@6124: HANDLE hand = CreateFile(OTTD2FS(filename), 0, 0, NULL, OPEN_EXISTING, 0, NULL); truelight@5757: if (hand == INVALID_HANDLE_VALUE) return 1; truelight@5757: CloseHandle(hand); truelight@5757: return 0; truelight@5757: #else glx@8378: return access(OTTD2FS(filename), 0) == 0; truelight@5757: #endif Darkvater@4220: } Darkvater@4221: peter1138@9031: typedef FiosType fios_getlist_callback_proc(SaveLoadDialogMode mode, const char *filename, const char *ext, char *title); Darkvater@4221: Darkvater@4221: /** Create a list of the files in a directory, according to some arbitrary rule. Darkvater@4221: * @param mode The mode we are in. Some modes don't allow 'parent'. belugas@6481: * @param callback_proc The function that is called where you need to do the filtering. Darkvater@4221: * @return Return the list of files. */ peter1138@9031: static FiosItem *FiosGetFileList(SaveLoadDialogMode mode, fios_getlist_callback_proc *callback_proc) Darkvater@4221: { Darkvater@4221: struct stat sb; Darkvater@4221: struct dirent *dirent; Darkvater@4221: DIR *dir; Darkvater@4221: FiosItem *fios; Darkvater@4221: int sort_start; Darkvater@6054: char d_name[sizeof(fios->name)]; Darkvater@4221: skidd13@9441: _fios_items.Clear(); skidd13@9441: Darkvater@4221: /* A parent directory link exists if we are not in the root directory */ Darkvater@4221: if (!FiosIsRoot(_fios_path) && mode != SLD_NEW_GAME) { skidd13@9441: fios = _fios_items.Append(); Darkvater@4221: fios->type = FIOS_TYPE_PARENT; Darkvater@4221: fios->mtime = 0; skidd13@10310: strecpy(fios->name, "..", lastof(fios->name)); skidd13@10310: strecpy(fios->title, ".. (Parent directory)", lastof(fios->title)); Darkvater@4221: } Darkvater@4221: Darkvater@4221: /* Show subdirectories */ Darkvater@6086: if (mode != SLD_NEW_GAME && (dir = ttd_opendir(_fios_path)) != NULL) { Darkvater@4221: while ((dirent = readdir(dir)) != NULL) { skidd13@10310: strecpy(d_name, FS2OTTD(dirent->d_name), lastof(d_name)); Darkvater@5167: Darkvater@4221: /* found file must be directory, but not '.' or '..' */ rubidium@10405: if (FiosIsValidFile(_fios_path, dirent, &sb) && S_ISDIR(sb.st_mode) && rubidium@6240: (!FiosIsHiddenFile(dirent) || strncasecmp(d_name, PERSONAL_DIR, strlen(d_name)) == 0) && rubidium@6240: strcmp(d_name, ".") != 0 && strcmp(d_name, "..") != 0) { skidd13@9441: fios = _fios_items.Append(); Darkvater@4221: fios->type = FIOS_TYPE_DIR; Darkvater@4221: fios->mtime = 0; skidd13@10310: strecpy(fios->name, d_name, lastof(fios->name)); Darkvater@5167: snprintf(fios->title, lengthof(fios->title), "%s" PATHSEP " (Directory)", d_name); Darkvater@4221: str_validate(fios->title); Darkvater@4221: } Darkvater@4221: } Darkvater@4221: closedir(dir); Darkvater@4221: } Darkvater@4221: Darkvater@4221: /* Sort the subdirs always by name, ascending, remember user-sorting order */ Darkvater@4221: { Darkvater@4221: byte order = _savegame_sort_order; Darkvater@4221: _savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING; skidd13@9441: qsort(_fios_items.Begin(), _fios_items.Length(), sizeof(FiosItem), compare_FiosItems); Darkvater@4221: _savegame_sort_order = order; Darkvater@4221: } Darkvater@4221: Darkvater@4221: /* This is where to start sorting for the filenames */ skidd13@9441: sort_start = _fios_items.Length(); Darkvater@4221: Darkvater@4221: /* Show files */ Darkvater@6086: dir = ttd_opendir(_fios_path); Darkvater@4221: if (dir != NULL) { Darkvater@4221: while ((dirent = readdir(dir)) != NULL) { Darkvater@4221: char fios_title[64]; Darkvater@4221: char *t; skidd13@10310: strecpy(d_name, FS2OTTD(dirent->d_name), lastof(d_name)); Darkvater@4221: rubidium@10405: if (!FiosIsValidFile(_fios_path, dirent, &sb) || !S_ISREG(sb.st_mode) || FiosIsHiddenFile(dirent)) continue; Darkvater@4221: Darkvater@4221: /* File has no extension, skip it */ Darkvater@5167: if ((t = strrchr(d_name, '.')) == NULL) continue; Darkvater@4221: fios_title[0] = '\0'; // reset the title; Darkvater@4221: peter1138@9031: FiosType type = callback_proc(mode, d_name, t, fios_title); Darkvater@4221: if (type != FIOS_TYPE_INVALID) { skidd13@9441: fios = _fios_items.Append(); Darkvater@4221: fios->mtime = sb.st_mtime; Darkvater@4221: fios->type = type; skidd13@10310: strecpy(fios->name, d_name, lastof(fios->name)); Darkvater@4221: Darkvater@4221: /* Some callbacks want to lookup the title of the file. Allow that. Darkvater@4221: * If we just copy the title from the filename, strip the extension */ Darkvater@5167: t = (fios_title[0] == '\0') ? *t = '\0', d_name : fios_title; skidd13@10310: strecpy(fios->title, t, lastof(fios->title)); Darkvater@4221: str_validate(fios->title); Darkvater@4221: } Darkvater@4221: } Darkvater@4221: closedir(dir); Darkvater@4221: } Darkvater@4221: skidd13@9441: qsort(_fios_items.Get(sort_start), _fios_items.Length() - sort_start, sizeof(FiosItem), compare_FiosItems); Darkvater@4221: Darkvater@4221: /* Show drives */ Darkvater@4221: if (mode != SLD_NEW_GAME) FiosGetDrives(); Darkvater@4221: skidd13@9441: _fios_items.Compact(); skidd13@9441: skidd13@9441: return _fios_items.Begin(); Darkvater@4221: } Darkvater@4221: Darkvater@4221: /** Darkvater@4221: * Callback for FiosGetFileList. It tells if a file is a savegame or not. Darkvater@4221: * @param mode Save/load mode. Darkvater@4221: * @param file Name of the file to check. Darkvater@4221: * @param ext A pointer to the extension identifier inside file smatz@9730: * @param title Buffer if a callback wants to lookup the title of the file; NULL to skip the lookup Darkvater@4221: * @return a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a savegame Darkvater@4221: * @see FiosGetFileList Darkvater@4221: * @see FiosGetSavegameList Darkvater@4221: */ smatz@9730: FiosType FiosGetSavegameListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title) Darkvater@4221: { Darkvater@4221: /* Show savegame files Darkvater@4221: * .SAV OpenTTD saved game Darkvater@4221: * .SS1 Transport Tycoon Deluxe preset game Darkvater@4221: * .SV1 Transport Tycoon Deluxe (Patch) saved game Darkvater@4221: * .SV2 Transport Tycoon Deluxe (Patch) saved 2-player game */ Darkvater@4221: if (strcasecmp(ext, ".sav") == 0) return FIOS_TYPE_FILE; Darkvater@4221: Darkvater@4221: if (mode == SLD_LOAD_GAME || mode == SLD_LOAD_SCENARIO) { Darkvater@4221: if (strcasecmp(ext, ".ss1") == 0 || strcasecmp(ext, ".sv1") == 0 || Darkvater@4221: strcasecmp(ext, ".sv2") == 0) { smatz@9730: if (title != NULL) GetOldSaveGameName(title, _fios_path, file); Darkvater@4221: return FIOS_TYPE_OLDFILE; Darkvater@4221: } Darkvater@4221: } Darkvater@4221: Darkvater@4221: return FIOS_TYPE_INVALID; Darkvater@4221: } Darkvater@4221: Darkvater@4221: /** Darkvater@4221: * Get a list of savegames. Darkvater@4221: * @param mode Save/load mode. Darkvater@4221: * @return A pointer to an array of FiosItem representing all the files to be shown in the save/load dialog. Darkvater@4221: * @see FiosGetFileList Darkvater@4221: */ skidd13@9441: void FiosGetSavegameList(SaveLoadDialogMode mode) Darkvater@4221: { peter1138@9031: static char *fios_save_path = NULL; Darkvater@4221: peter1138@9031: if (fios_save_path == NULL) { peter1138@9031: fios_save_path = MallocT(MAX_PATH); peter1138@9031: FioGetDirectory(fios_save_path, MAX_PATH, SAVE_DIR); Darkvater@4221: } Darkvater@4221: peter1138@9031: _fios_path = fios_save_path; Darkvater@4221: skidd13@9441: FiosGetFileList(mode, &FiosGetSavegameListCallback); Darkvater@4221: } Darkvater@4221: Darkvater@4221: /** Darkvater@4221: * Callback for FiosGetFileList. It tells if a file is a scenario or not. Darkvater@4221: * @param mode Save/load mode. Darkvater@4221: * @param file Name of the file to check. Darkvater@4221: * @param ext A pointer to the extension identifier inside file Darkvater@4221: * @param title Buffer if a callback wants to lookup the title of the file Darkvater@4221: * @return a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a scenario Darkvater@4221: * @see FiosGetFileList Darkvater@4221: * @see FiosGetScenarioList Darkvater@4221: */ peter1138@9031: static FiosType FiosGetScenarioListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title) Darkvater@4221: { Darkvater@4221: /* Show scenario files Darkvater@4221: * .SCN OpenTTD style scenario file Darkvater@4221: * .SV0 Transport Tycoon Deluxe (Patch) scenario Darkvater@4221: * .SS0 Transport Tycoon Deluxe preset scenario */ Darkvater@4221: if (strcasecmp(ext, ".scn") == 0) return FIOS_TYPE_SCENARIO; Darkvater@4221: Darkvater@4221: if (mode == SLD_LOAD_GAME || mode == SLD_LOAD_SCENARIO || mode == SLD_NEW_GAME) { Darkvater@4221: if (strcasecmp(ext, ".sv0") == 0 || strcasecmp(ext, ".ss0") == 0 ) { Darkvater@4221: GetOldSaveGameName(title, _fios_path, file); Darkvater@4221: return FIOS_TYPE_OLD_SCENARIO; Darkvater@4221: } Darkvater@4221: } Darkvater@4221: Darkvater@4221: return FIOS_TYPE_INVALID; Darkvater@4221: } Darkvater@4221: Darkvater@4221: /** Darkvater@4221: * Get a list of scenarios. Darkvater@4221: * @param mode Save/load mode. Darkvater@4221: * @return A pointer to an array of FiosItem representing all the files to be shown in the save/load dialog. Darkvater@4221: * @see FiosGetFileList Darkvater@4221: */ skidd13@9441: void FiosGetScenarioList(SaveLoadDialogMode mode) Darkvater@4221: { peter1138@9031: static char *fios_scn_path = NULL; Darkvater@4221: rubidium@6929: /* Copy the default path on first run or on 'New Game' */ peter1138@9031: if (fios_scn_path == NULL) { peter1138@9031: fios_scn_path = MallocT(MAX_PATH); peter1138@9031: FioGetDirectory(fios_scn_path, MAX_PATH, SCENARIO_DIR); Darkvater@4221: } Darkvater@4221: peter1138@9031: _fios_path = fios_scn_path; Darkvater@4221: skidd13@9441: FiosGetFileList(mode, &FiosGetScenarioListCallback); Darkvater@4221: } truelight@4300: peter1138@9031: static FiosType FiosGetHeightmapListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title) truelight@4300: { truelight@4300: /* Show heightmap files truelight@4300: * .PNG PNG Based heightmap files truelight@4300: * .BMP BMP Based heightmap files truelight@4300: */ truelight@4300: truelight@4300: #ifdef WITH_PNG truelight@4300: if (strcasecmp(ext, ".png") == 0) return FIOS_TYPE_PNG; truelight@4300: #endif /* WITH_PNG */ truelight@4300: truelight@4300: if (strcasecmp(ext, ".bmp") == 0) return FIOS_TYPE_BMP; truelight@4300: truelight@4300: return FIOS_TYPE_INVALID; truelight@4300: } truelight@4300: belugas@6179: /* Get a list of Heightmaps */ skidd13@9441: void FiosGetHeightmapList(SaveLoadDialogMode mode) truelight@4300: { peter1138@9031: static char *fios_hmap_path = NULL; truelight@4300: peter1138@9031: if (fios_hmap_path == NULL) { peter1138@9031: fios_hmap_path = MallocT(MAX_PATH); peter1138@9031: FioGetDirectory(fios_hmap_path, MAX_PATH, HEIGHTMAP_DIR); truelight@4300: } truelight@4300: peter1138@9031: _fios_path = fios_hmap_path; truelight@4300: skidd13@9441: FiosGetFileList(mode, &FiosGetHeightmapListCallback); truelight@4300: }