ms_fileutilities.hpp

/*
##############################################################################
# file: ms_fileutilities.hpp                                                 #
# 'msparser' toolkit                                                         #
# Utilities class that encompasses all file-system-related functionality     #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2012 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_fileutilities.hpp       $ #
#     $Author: francoisr@matrixscience.com $ #
#       $Date: 2022-02-17 16:09:54 +0000 $ #
#   $Revision: 200ee577031818b3e4ee95b4941bfb798dc45748 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_FILEUTILITIES_HPP
#define MS_FILEUTILITIES_HPP


#include <string>

// For _finddata_t
#ifdef _WIN32
#include <io.h>
#endif

// For off_t
#ifdef __GNU__
#include <unistd.h>
#endif

namespace matrix_science {
    class ms_mascotoptions;
#ifdef _WIN32
#if defined(_MSC_VER) && (_MSC_VER < 1300)
#define OFFSET64_C(c) c ## i64
#else
#define OFFSET64_C(c) c ## LL
#endif
    typedef INT64 OFFSET64_T;
#else // !_WIN32
#define OFFSET64_C(c) c ## LL
    typedef off_t   OFFSET64_T;
#endif // !_WIN32


    class MS_MASCOTRESFILE_API ms_fileutilities
    {
    public:
        ms_fileutilities();

        static time_t getLastModificationTime(const char* filename, ms_errs* err = NULL);

        static void setLastModificationTime(const char* filename, time_t modificationTime, ms_errs* err = NULL);

        static UINT64 getFileSize(const char* filename, ms_errs* err = NULL);

        static std::string findMascotDat(const char *szMascotDatFilename, 
                                         ms_errs * err = NULL,
                                         const int timeoutSec = 0 );

        static bool doesFileExist(const char* filename);

        static bool isFileWritable(const char * filePath);

        enum err_sar {
            SAR_SUCCESS,                        
            SAR_FAIL_CHMOD,                     
            SAR_FAIL_GET_NAMED_SECURITY_INFO,   
            SAR_FAIL_SET_ENTRIES_IN_ACL,        
            SAR_FAIL_SET_NAMED_SECURITY_INFO,   
            SAR_FAIL_CHOWN                      
        };

        err_sar setAccessRights(const char * filename, 
                                const bool bWrite, 
                                const bool bExecute, 
                                const bool isFile,
                                const ms_mascotoptions & Options,
                                const bool avoid_reapply = false);
        unsigned long getSARExtendedErrorCode() const;

        static bool isDirectory(const char * path);

#ifndef SWIG

        static int createDirectory(const std::string & directory, std::string & errorDirectory);
#else // SWIG Multiple return values
        static int createDirectory(const std::string & directory, std::string & OUTPUT);
#endif

        static int deleteDirectory(const std::string & directory, const bool bDeleteSubdirectories = true);

        bool findOpen(const std::string directory,
                      const std::string wildcard);

        bool findNext(std::string & fileName);

        void findClose();

        static std::string stripLastFolder(const std::string pathname);

        static std::string getMD5Sum(const std::string &str, const bool b32bitEncoding = true);

        enum CMD_ARGUMENT_PARSE_RESULT {
            CMD_ARGUMENT_PARSE_OK = 0, 
            CMD_ARGUMENT_PARSE_UNBALANCED = -1, 
            CMD_ARGUMENT_PARSE_COLLISION = -2, 
            CMD_ARGUMENT_PARSE_INVALIDCHAR = -3, 
        };

        static int parseCommandLineArgumentString(const std::string &command, std::vector<std::string> &components);

        enum compareXMLFiles_flags {
            CMPXML_NO_FLAG              = 0x0000,  
            CMPXML_IGN_DBL_IDENTICAL    = 0x0001,  
            CMPXML_IGN_DBL_DIFF_100_PPM = 0x0002,  
            CMPXML_IGN_DBL_DIFF_10_PPM  = 0x0004,  
            CMPXML_IGN_DBL_DIFF_1_PPM   = 0x0008,  
            CMPXML_IGN_DBL_MASK                  = (CMPXML_IGN_DBL_IDENTICAL | CMPXML_IGN_DBL_DIFF_100_PPM | CMPXML_IGN_DBL_DIFF_10_PPM | CMPXML_IGN_DBL_DIFF_1_PPM),

            CMPXML_STRIP_TRAILING_ZEROS = 0x0010,  
            CMPXML_IGN_COL_SIZE_EQ_ONE  = 0x0020,  
            CMPXML_IGN_TODAY_DATE       = 0x0040,  
            CMPXML_IGN_INF_999999       = 0x0080,  
            CMPXML_IGN_FILE_URL         = 0x0100,  
            CMPXML_IGN_RAWFILE_NAME     = 0x0200,  

            // CMPXML_IGN_IF_CWD_INCLUDED  = 0x0100,  //!< If there's a path name in an attribute and if that contains the current directory, then it's unlikey to match
        };
#ifndef SWIG

        static bool compareXmlFiles(const std::string & filePath1,
                                    const std::string & filePath2,
                                    const std::string & schemaPath,
                                    const int           flags,
                                    const std::vector<std::string> & ignoreElements,
                                    const std::vector<std::string> & ignoreAttributes,
                                          ms_errs     & errs,
                                          std::string & differences,
                                          std::string & lhsOnly,
                                          std::string & rhsOnly);
#else // SWIG Multiple return values
        static bool compareXmlFiles(const std::string & filePath1,
                                    const std::string & filePath2,
                                    const std::string & schemaPath,
                                    const int           flags,
                                    const std::vector<std::string> & ignoreElements,
                                    const std::vector<std::string> & ignoreAttributes,
                                    ms_errs     & errs,
                                    std::string & OUTPUT,
                                    std::string & OUTPUT,
                                    std::string & OUTPUT);
#endif

    private:
        unsigned long errorCode_;
#ifdef _WIN32
#if defined(_MSC_VER) && (_MSC_VER < 1300)
        struct _finddata_t fileFindInfo_;
        int fileFindPtr_;
#else
        struct __finddata64_t fileFindInfo_;
        intptr_t fileFindPtr_;
#endif
#else
        void * fileFindDir_;     // void * rather than DIR * so no need to include dirent.h
#endif
        std::string fileFindWildcard_;
        std::string fileFindDirectory_;

        static CMD_ARGUMENT_PARSE_RESULT splitCommandString(const std::string &command, const std::string::size_type j1, const std::string::size_type j2, std::vector<std::string> &argvstr);

        static const std::string ws_delims_;
        static const char begin_quote_ = '"';
        static const char end_quote_ = '"';
        static const std::string invalid_chars_;

    }; // class ms_fileutilities // end of tools_group
} // namespace matrix_science
#endif // MS_FILEUTILITIES_HPP

/*------------------------------- End of File -------------------------------*/