FileUtils.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* The Base of this class has been adopted from the Delta3D engine
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Class Inspired by the Delta3D Engine
* http://delta3dengine.org/
*
* @author David Guthrie
* @author Maxim Serebrennik
*/
#pragma once

#include <trUtil/Export.h>

#include <trUtil/Exception.h>
#include <trUtil/UnaryFunction.h>

#include <osg/Referenced>
#include <osg/Version>
#include <osgDB/ReaderWriter>
#include <osgDB/FileUtils>

#include <vector>
#include <string>

#if OPENSCENEGRAPH_MAJOR_VERSION < 3
namespace osgDB
{
    class ArchiveExtended;
}
#else
namespace osgDB
{
    using ArchiveExtended = Archive;
}
#endif

namespace trUtil
{
    class Log;

    using DirectoryContents = std::vector<std::string>;
    using FileExtensionList = std::vector<std::string>;

    enum FileType
    {
        FILE_NOT_FOUND,
        REGULAR_FILE,
        DIRECTORY,
        ARCHIVE
    };

    struct FileInfo
    {
        std::string fileName; 
        std::string path; 
        std::string baseName; 
        std::string extensionlessFileName; 
        std::string extension; 
        size_t size; 
        time_t lastModified; 
        FileType fileType; 
        bool isInArchive; 

        FileInfo() : size(0), lastModified(0), fileType(FILE_NOT_FOUND), isInArchive(false) {}
    };

    class TR_UTIL_EXPORT FileUtilIOException : public trUtil::Exception
    {
    public:
        FileUtilIOException(const std::string& message, const std::string& filename, unsigned int linenum);
        virtual ~FileUtilIOException() {};
    };

    class TR_UTIL_EXPORT FileNotFoundException : public trUtil::Exception
    {
    public:
        FileNotFoundException(const std::string& message, const std::string& filename, unsigned int linenum);
        virtual ~FileNotFoundException() {};
    };

    class TR_UTIL_EXPORT FileUtils : public osg::Referenced
    {
    public:
        static const char PATH_SEPARATOR; 

        static FileUtils& GetInstance()
        {
            if (mInstance == NULL)
            {
                mInstance = new FileUtils();
            }
            return *mInstance;
        }

        std::string RunCommand(const char* cmd);

        std::string RunCommand(const std::string cmd);

        bool FileExists(const std::string& strFile, bool caseInsensitive = false) const;

        void FileCopy(const std::string& strSrc, const std::string& strDest, bool bOverwrite) const;

        void FileMove(const std::string& strSrc, const std::string& strDest, bool bOverwrite) const;

        void FileDelete(const std::string& strFile) const;

        const struct FileInfo GetFileInfo(const std::string& strFile, bool caseInsensitive = false) const;

        void CleanupFileString(std::string &strFileOrDir) const;

        bool IsAbsolutePath(std::string strFileOrDir) const;

        void MakeDirectoryEX(std::string strDir);

        void ChangeDirectory(const std::string& path);

        const std::string& CurrentDirectory() const;

        void PushDirectory(const std::string& path);

        void PopDirectory();

        std::string GetAbsolutePath(const std::string& relativePath, bool removeFinalFile = false) const;

        DirectoryContents DirGetFiles(const std::string& path, const FileExtensionList& extensions = FileExtensionList()) const;

        DirectoryContents DirGetSubs(const std::string& path) const;

        void DirCopy(const std::string& srcPath, const std::string& destPath, bool bOverwrite, bool copyContentsOnly = false) const;

        bool DirDelete(const std::string& strDir, bool bRecursive);

        void MakeDirectory(const std::string& strDir) const;

        bool DirExists(const std::string& strDir, bool caseInsensitive = false) const;

        std::string RelativePath(const std::string& absolutePath, const std::string& file) const;

        //void AbsoluteToRelative(const std::string &absPath, std::string& relPath);

        bool IsSameFile(const std::string& file1, const std::string& file2) const;

        static std::string ConcatPaths(const std::string& left, const std::string& right);

        osg::Object* ReadObject(const std::string& filename, osgDB::ReaderWriter::Options* options = NULL);

        osg::Node* ReadNode(const std::string& filename, osgDB::ReaderWriter::Options* options = NULL);

        osgDB::ArchiveExtended* FindArchive(const std::string& archiveFileName) const;

    private:

        static const int PATH_BUFFER_SIZE = 1024;

        FileUtils();

        virtual ~FileUtils();

        void ChangeDirectoryInternal(const std::string& path);

        void InternalDirCopy(const std::string& srcPath, const std::string& destPath, bool bOverwrite) const;

        void RecursDeleteDir(bool bRecursive);

        bool SplitArchiveFilename(const std::string& fullFilename, std::string& archiveFilename, std::string& fileInArchive) const;

        void DirGetFilesInArchive(const osgDB::ArchiveExtended& a, const std::string& path, DirectoryContents& result) const;

        FileType GetFileTypeForFileInArchive(const osgDB::ArchiveExtended& a, const std::string& path) const;

        FileInfo GetFileInfoForFileInArchive(const osgDB::ArchiveExtended& a, const std::string& path) const;

        FileType GetFileTypeFromOSGDBFileType(osgDB::FileType ft) const;

        bool ContainsArchiveExtension(const std::string& path) const;

        std::string ArchiveRelativeToAbsolute(const std::string& relativeFile) const;

        const struct FileInfo GetFileInfo_Internal(const std::string& strFile, bool caseInsensitive) const;

        bool IsSameFile_Internal(const std::string& file1, const std::string& file2) const;


        static osg::ref_ptr<FileUtils> mInstance;

        trUtil::Logging::Log* mLogger;

        std::string mCurrentDirectory;
        std::vector<std::string> mStackOfDirectories;

    };

    class TR_UTIL_EXPORT DirectoryPush
    {
    public:

        DirectoryPush(const std::string& dir);

        ~DirectoryPush();

        bool GetSucceeded();

        const std::string& GetError();
    private:
        bool mSucceeded;
        std::string mError;
    };

    class IsPathSeparator : public trUtil::UnaryFunction<char, bool>
    {
    public:
        bool operator()(char c) const { return c == '/' || c == '\\' || c == FileUtils::PATH_SEPARATOR; }
    };
}