Logo Search packages:      
Sourcecode: scummvm version File versions  Download package

default-saves.cpp

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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; either version 2
 * of the License, or (at your option) any later version.

 * This program 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.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/tags/release-0-11-1/backends/saves/default/default-saves.cpp $
 * $Id: default-saves.cpp 30944 2008-02-23 22:50:18Z sev $
 *
 */

#if !defined(DISABLE_DEFAULT_SAVEFILEMANAGER)

#include "common/savefile.h"
#include "common/util.h"
#include "common/fs.h"
#include "common/file.h"
#include "common/config-manager.h"
#include "backends/saves/default/default-saves.h"
#include "backends/saves/compressed/compressed-saves.h"

#include <stdio.h>
#include <string.h>
#include <errno.h>

#if defined(UNIX) || defined(__SYMBIAN32__)
#include <sys/stat.h>
#endif


class StdioSaveFile : public Common::InSaveFile, public Common::OutSaveFile {
private:
      FILE *fh;
public:
      StdioSaveFile(const char *filename, bool saveOrLoad) {
            fh = ::fopen(filename, (saveOrLoad? "wb" : "rb"));
      }
      ~StdioSaveFile() {
            if (fh)
                  ::fclose(fh);
      }

      bool eos() const { return feof(fh) != 0; }
      bool ioFailed() const { return ferror(fh) != 0; }
      void clearIOFailed() { clearerr(fh); }

      bool isOpen() const { return fh != 0; }

      uint32 read(void *dataPtr, uint32 dataSize) {
            assert(fh);
            return fread(dataPtr, 1, dataSize, fh);
      }
      uint32 write(const void *dataPtr, uint32 dataSize) {
            assert(fh);
            return fwrite(dataPtr, 1, dataSize, fh);
      }

      uint32 pos() const {
            assert(fh);
            return ftell(fh);
      }
      uint32 size() const {
            assert(fh);
            uint32 oldPos = ftell(fh);
            fseek(fh, 0, SEEK_END);
            uint32 length = ftell(fh);
            fseek(fh, oldPos, SEEK_SET);
            return length;
      }

      void seek(int32 offs, int whence = SEEK_SET) {
            assert(fh);
            fseek(fh, offs, whence);
      }
};

static void join_paths(const char *filename, const char *directory,
                                                 char *buf, int bufsize) {
      buf[bufsize-1] = '\0';
      strncpy(buf, directory, bufsize-1);

#ifdef WIN32
      // Fix for Win98 issue related with game directory pointing to root drive ex. "c:\"
      if ((buf[0] != 0) && (buf[1] == ':') && (buf[2] == '\\') && (buf[3] == 0)) {
            buf[2] = 0;
      }
#endif

      const int dirLen = strlen(buf);

      if (dirLen > 0) {
#if defined(__MORPHOS__) || defined(__amigaos4__)
            if (buf[dirLen-1] != ':' && buf[dirLen-1] != '/')
#endif

#if !defined(__GP32__)
            strncat(buf, "/", bufsize-1); // prevent double /
#endif
      }
      strncat(buf, filename, bufsize-1);
}

00117 Common::StringList DefaultSaveFileManager::listSavefiles(const char *regex) {
      FilesystemNode savePath(getSavePath());
      FSList savefiles;
      Common::StringList results;
      Common::String search(regex);

      if (savePath.lookupFile(savefiles, search, false, true)) {
            for (FSList::const_iterator file = savefiles.begin(); file != savefiles.end(); ++file) {
                  results.push_back(file->getPath());
            }
      }

      return results;
}

00132 void DefaultSaveFileManager::checkPath(const char *path) {
      clearError();
      Common::String pathStr(path);

#if defined(UNIX) || defined(__SYMBIAN32__)
      struct stat sb;

      // Check whether the dir exists
      if (stat(path, &sb) == -1) {
            // The dir does not exist, or stat failed for some other reason.
            // If the problem was that the path pointed to nothing, try
            // to create the dir (ENOENT case).
            switch (errno) {
            case EACCES:
                  setError(SFM_DIR_ACCESS, "Search or write permission denied: "+pathStr);
                  break;
#if !defined(__SYMBIAN32__)
            case ELOOP:
                  setError(SFM_DIR_LOOP, "Too many symbolic links encountered while traversing the path: "+pathStr);
                  break;
#endif
            case ENAMETOOLONG:
                  setError(SFM_DIR_NAMETOOLONG, "The path name is too long: "+pathStr);
                  break;
            case ENOENT:
                  if (mkdir(path, 0755) != 0) {
                        // mkdir could fail for various reasons: The parent dir doesn't exist,
                        // or is not writeable, the path could be completly bogus, etc.
                        warning("mkdir for '%s' failed!", path);
                        perror("mkdir");

                        switch (errno) {
                        case EACCES:
                              setError(SFM_DIR_ACCESS, "Search or write permission denied: "+pathStr);
                              break;
                        case EMLINK:
                              setError(SFM_DIR_LINKMAX, "The link count of the parent directory would exceed {LINK_MAX}: "+pathStr);
                              break;
#if !defined(__SYMBIAN32__)
                        case ELOOP:
                              setError(SFM_DIR_LOOP, "Too many symbolic links encountered while traversing the path: "+pathStr);
                              break;
#endif
                        case ENAMETOOLONG:
                              setError(SFM_DIR_NAMETOOLONG, "The path name is too long: "+pathStr);
                              break;
                        case ENOENT:
                              setError(SFM_DIR_NOENT, "A component of the path does not exist, or the path is an empty string: "+pathStr);
                              break;
                        case ENOTDIR:
                              setError(SFM_DIR_NOTDIR, "A component of the path prefix is not a directory: "+pathStr);
                              break;
                        case EROFS:
                              setError(SFM_DIR_ROFS, "The parent directory resides on a read-only file system:"+pathStr);
                              break;
                        }
                  }
                  break;
            case ENOTDIR:
                  setError(SFM_DIR_NOTDIR, "A component of the path prefix is not a directory: "+pathStr);
                  break;
            }
      } else {
            // So stat() succeeded. But is the path actually pointing to a directory?
            if (!S_ISDIR(sb.st_mode)) {
                  setError(SFM_DIR_NOTDIR, "The given savepath is not a directory: "+pathStr);
            }
      }
#endif
}

00203 Common::InSaveFile *DefaultSaveFileManager::openForLoading(const char *filename) {
      // Ensure that the savepath is valid. If not, generate an appropriate error.
      char buf[256];
      const char *savePath = getSavePath();
      checkPath(savePath);
      
      if (getError() == SFM_NO_ERROR) {
            join_paths(filename, savePath, buf, sizeof(buf));
            StdioSaveFile *sf = new StdioSaveFile(buf, false);
      
            if (!sf->isOpen()) {
                  delete sf;
                  sf = 0;
            }
            
            return wrapInSaveFile(sf);
      } else {
            return 0;
      }
}

00224 Common::OutSaveFile *DefaultSaveFileManager::openForSaving(const char *filename) {
      // Ensure that the savepath is valid. If not, generate an appropriate error.
      char buf[256];
      const char *savePath = getSavePath();
      checkPath(savePath);

      if (getError() == SFM_NO_ERROR) {
            join_paths(filename, savePath, buf, sizeof(buf));
            StdioSaveFile *sf = new StdioSaveFile(buf, true);
      
            if (!sf->isOpen()) {
                  delete sf;
                  sf = 0;
            }
      
            return wrapOutSaveFile(sf);
      } else {
            return 0;
      }
}

00245 bool DefaultSaveFileManager::removeSavefile(const char *filename) {
      char buf[256];
      clearError();
      Common::String filenameStr;
      join_paths(filename, getSavePath(), buf, sizeof(buf));
      
      if (remove(buf) != 0) {
#ifndef _WIN32_WCE
            if (errno == EACCES)
                  setError(SFM_DIR_ACCESS, "Search or write permission denied: "+filenameStr);
            
            if (errno == ENOENT)
                  setError(SFM_DIR_NOENT, "A component of the path does not exist, or the path is an empty string: "+filenameStr);
#endif
            return false;
      } else {
            return true;
      }
}

00265 const char *DefaultSaveFileManager::getSavePath() const {

#if defined(PALMOS_MODE) || defined(__PSP__)
      return SCUMMVM_SAVEPATH;
#else

      const char *dir = NULL;

      // Try to use game specific savepath from config
      dir = ConfMan.get("savepath").c_str();

      // Work around a bug (#999122) in the original 0.6.1 release of
      // ScummVM, which would insert a bad savepath value into config files.
      if (0 == strcmp(dir, "None")) {
            ConfMan.removeKey("savepath", ConfMan.getActiveDomainName());
            ConfMan.flushToDisk();
            dir = ConfMan.get("savepath").c_str();
      }

#ifdef _WIN32_WCE
      if (dir[0] == 0)
            dir = ConfMan.get("path").c_str();
#endif

      assert(dir);

      return dir;
#endif
}

#endif // !defined(DISABLE_DEFAULT_SAVEFILEMANAGER)

Generated by  Doxygen 1.6.0   Back to index