src/ini.cpp

   1 /* $Id: ini.cpp 26058 2013-11-23 13:15:07Z rubidium $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file ini.cpp Definition of the IniItem class, related to reading/writing '*.ini' files. */
  11
  12 #include "stdafx.h"
  13 #include "debug.h"
  14 #include "ini_type.h"
  15 #include "string_func.h"
  16 #include "fileio_func.h"
  17
  18 #if (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 199309L) || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 500)
  19 # include <unistd.h>
  20 #endif
  21
  22 #ifdef WIN32
  23 # include <windows.h>
  24 # include <shellapi.h>
  25 # include "core/mem_func.hpp"
  26 #endif
  27
  28 #include "safeguards.h"
  29
  30 /**
  31  * Create a new ini file with given group names.
  32  * @param list_group_names A \c NULL terminated list with group names that should be loaded as lists instead of variables. @see IGT_LIST
  33  */
  34 IniFile::IniFile(const char * const *list_group_names) : IniLoadFile(list_group_names)
  35 {
  36 }
  37
  38 /**
  39  * Save the Ini file's data to the disk.
  40  * @param filename the file to save to.
  41  * @return true if saving succeeded.
  42  */
  43 bool IniFile::SaveToDisk(const char *filename)
  44 {
  45         /*
  46          * First write the configuration to a (temporary) file and then rename
  47          * that file. This to prevent that when OpenTTD crashes during the save
  48          * you end up with a truncated configuration file.
  49          */
  50         char file_new[MAX_PATH];
  51
  52         strecpy(file_new, filename, lastof(file_new));
  53         strecat(file_new, ".new", lastof(file_new));
  54         FILE *f = fopen(file_new, "w");
  55         if (f == NULL) return false;
  56
  57         for (const IniGroup *group = this->group; group != NULL; group = group->next) {
  58                 if (group->comment) fputs(group->comment, f);
  59                 fprintf(f, "[%s]\n", group->name);
  60                 for (const IniItem *item = group->item; item != NULL; item = item->next) {
  61                         if (item->comment != NULL) fputs(item->comment, f);
  62
  63                         /* protect item->name with quotes if needed */
  64                         if (strchr(item->name, ' ') != NULL ||
  65                                         item->name[0] == '[') {
  66                                 fprintf(f, "\"%s\"", item->name);
  67                         } else {
  68                                 fprintf(f, "%s", item->name);
  69                         }
  70
  71                         fprintf(f, " = %s\n", item->value == NULL ? "" : item->value);
  72                 }
  73         }
  74         if (this->comment) fputs(this->comment, f);
  75
  76 /*
  77  * POSIX (and friends) do not guarantee that when a file is closed it is
  78  * flushed to the disk. So we manually flush it do disk if we have the
  79  * APIs to do so. We only need to flush the data as the metadata itself
  80  * (modification date etc.) is not important to us; only the real data is.
  81  */
  82 #if defined(_POSIX_SYNCHRONIZED_IO) && _POSIX_SYNCHRONIZED_IO > 0
  83         int ret = fdatasync(fileno(f));
  84         fclose(f);
  85         if (ret != 0) return false;
  86 #else
  87         fclose(f);
  88 #endif
  89
  90 #if defined(WIN32) || defined(WIN64)
  91         /* _tcsncpy = strcpy is TCHAR is char, but isn't when TCHAR is wchar. */
  92         #undef strncpy
  93         /* Allocate space for one more \0 character. */
  94         TCHAR tfilename[MAX_PATH + 1], tfile_new[MAX_PATH + 1];
  95         _tcsncpy(tfilename, OTTD2FS(filename), MAX_PATH);
  96         _tcsncpy(tfile_new, OTTD2FS(file_new), MAX_PATH);
  97         /* SHFileOperation wants a double '\0' terminated string. */
  98         tfilename[MAX_PATH - 1] = '\0';
  99         tfile_new[MAX_PATH - 1] = '\0';
 100         tfilename[_tcslen(tfilename) + 1] = '\0';
 101         tfile_new[_tcslen(tfile_new) + 1] = '\0';
 102
 103         /* Rename file without any user confirmation. */
 104         SHFILEOPSTRUCT shfopt;
 105         MemSetT(&shfopt, 0);
 106         shfopt.wFunc  = FO_MOVE;
 107         shfopt.fFlags = FOF_NOCONFIRMATION | FOF_NOCONFIRMMKDIR | FOF_NOERRORUI | FOF_SILENT;
 108         shfopt.pFrom  = tfile_new;
 109         shfopt.pTo    = tfilename;
 110         SHFileOperation(&shfopt);
 111 #else
 112         if (rename(file_new, filename) < 0) {
 113                 DEBUG(misc, 0, "Renaming %s to %s failed; configuration not saved", file_new, filename);
 114         }
 115 #endif
 116
 117         return true;
 118 }
 119
 120 /* virtual */ FILE *IniFile::OpenFile(const char *filename, Subdirectory subdir, size_t *size)
 121 {
 122         /* Open the text file in binary mode to prevent end-of-line translations
 123          * done by ftell() and friends, as defined by K&R. */
 124         return FioFOpenFile(filename, "rb", subdir, size);
 125 }
 126
 127 /* virtual */ void IniFile::ReportFileError(const char * const pre, const char * const buffer, const char * const post)
 128 {
 129         ShowInfoF("%s%s%s", pre, buffer, post);
 130 }