diff --git a/source/cppfs/CMakeLists.txt b/source/cppfs/CMakeLists.txt index aa37eda..a33cf7c 100644 --- a/source/cppfs/CMakeLists.txt +++ b/source/cppfs/CMakeLists.txt @@ -68,6 +68,7 @@ set(headers ${include_path}/Diff.h ${include_path}/Change.h ${include_path}/units.h + ${include_path}/directorytraversal.h ${include_path}/${localfs}/LocalFileSystem.h ${include_path}/${localfs}/LocalFileHandle.h @@ -92,6 +93,7 @@ set(sources ${source_path}/Tree.cpp ${source_path}/Diff.cpp ${source_path}/Change.cpp + ${source_path}/directorytraversal.cpp ${source_path}/${localfs}/LocalFileSystem.cpp ${source_path}/${localfs}/LocalFileHandle.cpp diff --git a/source/cppfs/include/cppfs/FilePath.h b/source/cppfs/include/cppfs/FilePath.h index 7150686..d655ecd 100644 --- a/source/cppfs/include/cppfs/FilePath.h +++ b/source/cppfs/include/cppfs/FilePath.h @@ -113,6 +113,36 @@ class CPPFS_API FilePath */ FilePath & operator=(FilePath && filePath); + /** + * @brief + * Equality operator + * + * @param[in] other + * The other file path for comparison + * + * @return + * `true` if both file paths are equal, else `false` + * + * @remark + * Two file paths are considered equal if the contents of the path are equal + */ + bool operator==(const FilePath & other) const; + + /** + * @brief + * Inequality operator + * + * @param[in] other + * The other file path for comparison + * + * @return + * `true` if both file paths differ, else `false` + * + * @remark + * Two file paths are considered equal if the contents of the path are equal + */ + bool operator!=(const FilePath & other) const; + /** * @brief * Get path as string @@ -127,6 +157,15 @@ class CPPFS_API FilePath */ const std::string & path() const; + /** + * @brief + * Get original (unprocessed) input string + * + * @return + * Path that was originally provided + */ + const std::string & originalPath() const; + /** * @brief * Set path @@ -345,6 +384,7 @@ class CPPFS_API FilePath protected: + std::string m_originalPath; ///< Original unprocessed input string std::string m_path; ///< Path (unified format) bool m_pointsToContent; ///< 'true' if the path has a trailing separator, else 'false' diff --git a/source/cppfs/include/cppfs/directorytraversal.h b/source/cppfs/include/cppfs/directorytraversal.h new file mode 100644 index 0000000..5db7ada --- /dev/null +++ b/source/cppfs/include/cppfs/directorytraversal.h @@ -0,0 +1,100 @@ + +#pragma once + + +#include +#include +#include + +#include + + +namespace cppfs +{ + + +/** +* @brief +* List all files in a directory +* +* @param[in] directory +* Path to directory (exluding a trailing '`/`'!) +* @param[in] recursive +* Search recursively in sub-directories? +* @param[out] files +* List of files +* +* @remark +* Lists all files in the directory, including all +* files in sub-directories if recursive is true. +* +* @remark +* Only files are listed, directories are not included. +* +* @remark +* The search path is included in the file name, e.g., +* getFile("dir") may result in ["dir/file1.txt", "dir/file2.png", ...]. +*/ +CPPFS_API void getFiles(const std::string & directory, bool recursive, std::vector & files); + +/** +* @brief +* List all files in a directory +* +* @param[in] directory +* Path to directory (exluding a trailing '`/`'!) +* @param[in] recursive +* Search recursively in sub-directories? +* +* @return +* List of files +*/ +CPPFS_API std::vector getFiles(const std::string & directory, bool recursive); + +/** +* @brief +* List all files in a directory +* +* @param[in] directories +* Vector of paths to directories (exluding a trailing '`/`'!) +* @param[in] recursive +* Search recursively in sub-directories? +* +* @return +* List of files +*/ +CPPFS_API std::vector getFiles(const std::vector & directories, bool recursive); + +/** +* @brief +* Scan directory for files with a specific filename extension +* +* @param[in] directory +* Path to directory +* @param[in] fileExtension +* File extension ('`*`' for all files) +* @param[in] recursive +* Search recursively in sub-directories? +* +* @return +* List of found files, including the directory name +*/ +CPPFS_API std::vector scanDirectory(const std::string & directory, const std::string & fileExtension, bool recursive = false); + +/** +* @brief +* Scan directory for files with a specific filename extension +* +* @param[in] directory +* Path to directory +* @param[in] fileExtension +* File extension ('`*`' for all files) +* @param[in] recursive +* Search recursively in sub-directories? +* @param[in] callback +* Function that is called for each found file +*/ +CPPFS_API void scanDirectory(const std::string & directory, const std::string & fileExtension, bool recursive, const std::function & callback); + + +} // namespace cppfs diff --git a/source/cppfs/include/cppfs/fs.h b/source/cppfs/include/cppfs/fs.h index 092a69f..629cda0 100644 --- a/source/cppfs/include/cppfs/fs.h +++ b/source/cppfs/include/cppfs/fs.h @@ -85,6 +85,18 @@ CPPFS_API std::string fromBase64(const std::string & base64); */ CPPFS_API std::string hashToString(const unsigned char * hash); +/** +* @brief +* Create directory +* +* @param[in] path +* Path to directory +* +* @return +* 0 on success, error code > 0 otherwise +*/ +CPPFS_API int makeDir(const std::string & path); + } // namespace fs diff --git a/source/cppfs/source/FilePath.cpp b/source/cppfs/source/FilePath.cpp index bb09850..114b55b 100644 --- a/source/cppfs/source/FilePath.cpp +++ b/source/cppfs/source/FilePath.cpp @@ -12,14 +12,16 @@ namespace cppfs FilePath::FilePath() -: m_path("") +: m_originalPath("") +, m_path("") , m_pointsToContent(false) , m_details(false) { } FilePath::FilePath(const FilePath & filePath) -: m_path(filePath.m_path) +: m_originalPath(filePath.m_originalPath) +, m_path(filePath.m_path) , m_pointsToContent(filePath.m_pointsToContent) , m_details(filePath.m_details) , m_fullPath(filePath.m_fullPath) @@ -33,7 +35,8 @@ FilePath::FilePath(const FilePath & filePath) } FilePath::FilePath(FilePath && filePath) -: m_path(std::move(filePath.m_path)) +: m_originalPath(std::move(filePath.m_path)) +, m_path(std::move(filePath.m_path)) , m_pointsToContent(std::move(filePath.m_pointsToContent)) , m_details(std::move(filePath.m_details)) , m_fullPath(std::move(filePath.m_fullPath)) @@ -73,6 +76,7 @@ FilePath::~FilePath() FilePath & FilePath::operator=(const FilePath & filePath) { + m_originalPath = filePath.m_originalPath; m_path = filePath.m_path; m_pointsToContent = filePath.m_pointsToContent; m_details = filePath.m_details; @@ -89,6 +93,7 @@ FilePath & FilePath::operator=(const FilePath & filePath) FilePath & FilePath::operator=(FilePath && filePath) { + m_originalPath = std::move(filePath.m_originalPath); m_path = std::move(filePath.m_path); m_pointsToContent = std::move(filePath.m_pointsToContent); m_details = std::move(filePath.m_details); @@ -103,14 +108,40 @@ FilePath & FilePath::operator=(FilePath && filePath) return *this; } +bool FilePath::operator==(const FilePath & other) const +{ + if (this == &other) + { + return true; + } + + return m_path == other.m_path; +} + +bool FilePath::operator!=(const FilePath & other) const +{ + if (this == &other) + { + return false; + } + + return m_path != other.m_path; +} + const std::string & FilePath::path() const { return m_path; } +const std::string & FilePath::originalPath() const +{ + return m_originalPath; +} + void FilePath::setPath(const std::string & path) { // Set new path + m_originalPath = path; m_path = path; // Reset state @@ -138,6 +169,7 @@ void FilePath::setPath(const std::string & path) void FilePath::setPath(std::string && path) { // Set new path + m_originalPath = path; m_path = std::move(path); // Reset state diff --git a/source/cppfs/source/directorytraversal.cpp b/source/cppfs/source/directorytraversal.cpp new file mode 100644 index 0000000..ceac78b --- /dev/null +++ b/source/cppfs/source/directorytraversal.cpp @@ -0,0 +1,141 @@ + +#include + +#include +#include + +#ifdef SYSTEM_WINDOWS + #include + #include "dirent_msvc.h" +#else + #include +#endif + +#include + + +namespace cppfs +{ + + +void getFiles(const std::string & directory, bool recursive, std::vector & files) +{ + // Open directory + DIR * dir = opendir(directory.c_str()); + if (!dir) + { + std::cout << "Could not open directory " << directory << "." << std::endl; + return; + } + + // Read directory entries + while (dirent * entry = readdir(dir)) + { + // Compose complete path + const std::string name = entry->d_name; + const std::string path = directory + "/" + name; + + // Check if entry points to a file or a directory + bool isDir = false; + bool isFile = false; + if (entry->d_type == DT_DIR) + { + isDir = true; + } + else if (entry->d_type == DT_REG) + { + isFile = true; + } + else if (entry->d_type == DT_UNKNOWN) + { + DIR * subDir = opendir(path.c_str()); + isDir = (subDir != nullptr); + isFile = !isDir; + if (subDir != nullptr) + closedir(subDir); + } + + // Make sure that the type of entry has been determined + assert(!(isDir && isFile)); + + // Recurse into sub-directories + if (isDir && recursive && name != "." && name != "..") + { + getFiles(path, true, files); + } + + // Add files to list + else if (isFile) + { + files.push_back(path); + } + } + + // Close directory handle + closedir(dir); +} + +std::vector getFiles(const std::string & directory, bool recursive) +{ + std::vector files; + + getFiles(directory, recursive, files); + + return files; +} + +std::vector getFiles(const std::vector & directories, bool recursive) +{ + std::vector files; + + for (const std::string & directory : directories) + { + const std::vector fs(cppfs::getFiles(directory, recursive)); + files.insert(files.end(), fs.begin(), fs.end()); + } + + return files; +} + +std::vector scanDirectory(const std::string & directory, const std::string & fileExtension, bool recursive) +{ + const auto sanitizedDirectory = directory.back() == '/' ? directory.substr(0, directory.size() - 1) : directory; + + std::vector fileList; + + // Get all files in the directory + auto files = getFiles(sanitizedDirectory, recursive); + for (const std::string & file : files) + { + // Check extension + std::string extension = FilePath(file).extension(); + if (fileExtension != "*" && extension != fileExtension) + continue; + + // Add file to list + fileList.push_back(file); + } + + return fileList; +} + +void scanDirectory(const std::string & directory, const std::string & fileExtension, bool recursive, const std::function & callback) +{ + const auto sanitizedDirectory = directory.back() == '/' ? directory.substr(0, directory.size() - 1) : directory; + + // Get all files in the directory + auto files = getFiles(sanitizedDirectory, recursive); + for (const std::string & file : files) + { + // Check extension + std::string extension = FilePath(file).extension(); + if (fileExtension != "*" && extension != fileExtension) + continue; + + // Call callback function + callback(file); + } +} + + +} // namespace cppfs diff --git a/source/cppfs/source/dirent_msvc.h b/source/cppfs/source/dirent_msvc.h new file mode 100644 index 0000000..6b06ba6 --- /dev/null +++ b/source/cppfs/source/dirent_msvc.h @@ -0,0 +1,900 @@ +/* + * dirent.h - dirent API for Microsoft Visual Studio + * + * Copyright (C) 2006-2012 Toni Ronkko + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * ``Software''), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL TONI RONKKO BE LIABLE FOR ANY CLAIM, DAMAGES OR + * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + * + * + * Version 1.13, Dec 12 2012, Toni Ronkko + * Use traditional 8+3 file name if the name cannot be represented in the + * default ANSI code page. Now compiles again with MSVC 6.0. Thanks to + * Konstantin Khomoutov for testing. + * + * Version 1.12.1, Oct 1 2012, Toni Ronkko + * Bug fix: renamed wide-character DIR structure _wDIR to _WDIR (with + * capital W) in order to maintain compatibility with MingW. + * + * Version 1.12, Sep 30 2012, Toni Ronkko + * Define PATH_MAX and NAME_MAX. Added wide-character variants _wDIR, + * _wdirent, _wopendir(), _wreaddir(), _wclosedir() and _wrewinddir(). + * Thanks to Edgar Buerkle and Jan Nijtmans for ideas and code. + * + * Do not include windows.h. This allows dirent.h to be integrated more + * easily into programs using winsock. Thanks to Fernando Azaldegui. + * + * Version 1.11, Mar 15, 2011, Toni Ronkko + * Defined FILE_ATTRIBUTE_DEVICE for MSVC 6.0. + * + * Version 1.10, Aug 11, 2010, Toni Ronkko + * Added d_type and d_namlen fields to dirent structure. The former is + * especially useful for determining whether directory entry represents a + * file or a directory. For more information, see + * http://www.delorie.com/gnu/docs/glibc/libc_270.html + * + * Improved conformance to the standards. For example, errno is now set + * properly on failure and assert() is never used. Thanks to Peter Brockam + * for suggestions. + * + * Fixed a bug in rewinddir(): when using relative directory names, change + * of working directory no longer causes rewinddir() to fail. + * + * Version 1.9, Dec 15, 2009, John Cunningham + * Added rewinddir member function + * + * Version 1.8, Jan 18, 2008, Toni Ronkko + * Using FindFirstFileA and WIN32_FIND_DATAA to avoid converting string + * between multi-byte and unicode representations. This makes the + * code simpler and also allows the code to be compiled under MingW. Thanks + * to Azriel Fasten for the suggestion. + * + * Mar 4, 2007, Toni Ronkko + * Bug fix: due to the strncpy_s() function this file only compiled in + * Visual Studio 2005. Using the new string functions only when the + * compiler version allows. + * + * Nov 2, 2006, Toni Ronkko + * Major update: removed support for Watcom C, MS-DOS and Turbo C to + * simplify the file, updated the code to compile cleanly on Visual + * Studio 2005 with both unicode and multi-byte character strings, + * removed rewinddir() as it had a bug. + * + * Aug 20, 2006, Toni Ronkko + * Removed all remarks about MSVC 1.0, which is antiqued now. Simplified + * comments by removing SGML tags. + * + * May 14 2002, Toni Ronkko + * Embedded the function definitions directly to the header so that no + * source modules need to be included in the Visual Studio project. Removed + * all the dependencies to other projects so that this header file can be + * used independently. + * + * May 28 1998, Toni Ronkko + * First version. + */ + +#ifndef DIRENT_H +#define DIRENT_H + +#ifdef _MSC_VER + #pragma warning (push) + #pragma warning (disable: 4505) // 'identifier': unreferenced local function has been removed +#endif + +#if !defined(_68K_) && !defined(_MPPC_) && !defined(_X86_) && !defined(_IA64_) && !defined(_AMD64_) && defined(_M_IX86) +# define _X86_ +#endif +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* Indicates that d_type field is available in dirent structure */ +#define _DIRENT_HAVE_D_TYPE + +/* Indicates that d_namlen field is available in dirent structure */ +#define _DIRENT_HAVE_D_NAMLEN + +/* Entries missing from MSVC 6.0 */ +#if !defined(FILE_ATTRIBUTE_DEVICE) +# define FILE_ATTRIBUTE_DEVICE 0x40 +#endif + +/* File type and permission flags for stat() */ +#if !defined(S_IFMT) +# define S_IFMT _S_IFMT /* File type mask */ +#endif +#if !defined(S_IFDIR) +# define S_IFDIR _S_IFDIR /* Directory */ +#endif +#if !defined(S_IFCHR) +# define S_IFCHR _S_IFCHR /* Character device */ +#endif +#if !defined(S_IFFIFO) +# define S_IFFIFO _S_IFFIFO /* Pipe */ +#endif +#if !defined(S_IFREG) +# define S_IFREG _S_IFREG /* Regular file */ +#endif +#if !defined(S_IREAD) +# define S_IREAD _S_IREAD /* Read permission */ +#endif +#if !defined(S_IWRITE) +# define S_IWRITE _S_IWRITE /* Write permission */ +#endif +#if !defined(S_IEXEC) +# define S_IEXEC _S_IEXEC /* Execute permission */ +#endif +#if !defined(S_IFIFO) +# define S_IFIFO _S_IFIFO /* Pipe */ +#endif +#if !defined(S_IFBLK) +# define S_IFBLK 0 /* Block device */ +#endif +#if !defined(S_IFLNK) +# define S_IFLNK 0 /* Link */ +#endif +#if !defined(S_IFSOCK) +# define S_IFSOCK 0 /* Socket */ +#endif + +#if defined(_MSC_VER) +# define S_IRUSR S_IREAD /* Read user */ +# define S_IWUSR S_IWRITE /* Write user */ +# define S_IXUSR 0 /* Execute user */ +# define S_IRGRP 0 /* Read group */ +# define S_IWGRP 0 /* Write group */ +# define S_IXGRP 0 /* Execute group */ +# define S_IROTH 0 /* Read others */ +# define S_IWOTH 0 /* Write others */ +# define S_IXOTH 0 /* Execute others */ +#endif + +/* Maximum length of file name */ +#if !defined(PATH_MAX) +# define PATH_MAX MAX_PATH +#endif +#if !defined(FILENAME_MAX) +# define FILENAME_MAX MAX_PATH +#endif +#if !defined(NAME_MAX) +# define NAME_MAX FILENAME_MAX +#endif + +/* File type flags for d_type */ +#define DT_UNKNOWN 0 +#define DT_REG S_IFREG +#define DT_DIR S_IFDIR +#define DT_FIFO S_IFIFO +#define DT_SOCK S_IFSOCK +#define DT_CHR S_IFCHR +#define DT_BLK S_IFBLK +#define DT_LNK S_IFLNK + +/* Macros for converting between st_mode and d_type */ +#define IFTODT(mode) ((mode) & S_IFMT) +#define DTTOIF(type) (type) + +/* + * File type macros. Note that block devices, sockets and links cannot be + * distinguished on Windows and the macros S_ISBLK, S_ISSOCK and S_ISLNK are + * only defined for compatibility. These macros should always return false + * on Windows. + */ +#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO) +#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR) +#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG) +#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK) +#define S_ISSOCK(mode) (((mode) & S_IFMT) == S_IFSOCK) +#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR) +#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK) + +/* Return the exact length of d_namlen without zero terminator */ +#define _D_EXACT_NAMLEN(p) ((p)->d_namlen) + +/* Return number of bytes needed to store d_namlen */ +#define _D_ALLOC_NAMLEN(p) (PATH_MAX + 1) + + +#ifdef __cplusplus +extern "C" { +#endif + + +/* Wide-character version */ +struct _wdirent { + long d_ino; /* Always zero */ + unsigned short d_reclen; /* Structure size */ + size_t d_namlen; /* Length of name without \0 */ + int d_type; /* File type */ + wchar_t d_name[PATH_MAX + 1]; /* File name */ +}; +typedef struct _wdirent _wdirent; + +struct _WDIR { + struct _wdirent ent; /* Current directory entry */ + WIN32_FIND_DATAW data; /* Private file data */ + int cached; /* True if data is valid */ + HANDLE handle; /* Win32 search handle */ + wchar_t *patt; /* Initial directory name */ +}; +typedef struct _WDIR _WDIR; + +static _WDIR *_wopendir (const wchar_t *dirname); +static struct _wdirent *_wreaddir (_WDIR *dirp); +static int _wclosedir (_WDIR *dirp); +static void _wrewinddir (_WDIR* dirp); + + +/* For compatibility with Symbian */ +#define wdirent _wdirent +#define WDIR _WDIR +#define wopendir _wopendir +#define wreaddir _wreaddir +#define wclosedir _wclosedir +#define wrewinddir _wrewinddir + + +/* Multi-byte character versions */ +struct dirent { + long d_ino; /* Always zero */ + unsigned short d_reclen; /* Structure size */ + size_t d_namlen; /* Length of name without \0 */ + int d_type; /* File type */ + char d_name[PATH_MAX + 1]; /* File name */ +}; +typedef struct dirent dirent; + +struct DIR { + struct dirent ent; + struct _WDIR *wdirp; +}; +typedef struct DIR DIR; + +static DIR *opendir (const char *dirname); +static struct dirent *readdir (DIR *dirp); +static int closedir (DIR *dirp); +static void rewinddir (DIR* dirp); + + +/* Internal utility functions */ +static WIN32_FIND_DATAW *dirent_first (_WDIR *dirp); +static WIN32_FIND_DATAW *dirent_next (_WDIR *dirp); + +static int dirent_mbstowcs_s( + size_t *pReturnValue, + wchar_t *wcstr, + size_t sizeInWords, + const char *mbstr, + size_t count); + +static int dirent_wcstombs_s( + size_t *pReturnValue, + char *mbstr, + size_t sizeInBytes, + const wchar_t *wcstr, + size_t count); + +static void dirent_set_errno (int error); + +/* + * Open directory stream DIRNAME for read and return a pointer to the + * internal working area that is used to retrieve individual directory + * entries. + */ +static _WDIR* +_wopendir( + const wchar_t *dirname) +{ + _WDIR *dirp = NULL; + int error; + + /* Must have directory name */ + if (dirname == NULL || dirname[0] == '\0') { + dirent_set_errno (ENOENT); + return NULL; + } + + /* Allocate new _WDIR structure */ + dirp = (_WDIR*) malloc (sizeof (struct _WDIR)); + if (dirp != NULL) { + DWORD n; + + /* Reset _WDIR structure */ + dirp->handle = INVALID_HANDLE_VALUE; + dirp->patt = NULL; + dirp->cached = 0; + + /* Compute the length of full path plus zero terminator */ + n = GetFullPathNameW (dirname, 0, NULL, NULL); + + /* Allocate room for absolute directory name and search pattern */ + dirp->patt = (wchar_t*) malloc (sizeof (wchar_t) * n + 16); + if (dirp->patt) { + + /* + * Convert relative directory name to an absolute one. This + * allows rewinddir() to function correctly even when current + * working directory is changed between opendir() and rewinddir(). + */ + n = GetFullPathNameW (dirname, n, dirp->patt, NULL); + if (n > 0) { + wchar_t *p; + + /* Append search pattern \* to the directory name */ + p = dirp->patt + n; + if (dirp->patt < p) { + switch (p[-1]) { + case '\\': + case '/': + case ':': + /* Directory ends in path separator, e.g. c:\temp\ */ + /*NOP*/; + break; + + default: + /* Directory name doesn't end in path separator */ + *p++ = '\\'; + } + } + *p++ = '*'; + *p = '\0'; + + /* Open directory stream and retrieve the first entry */ + if (dirent_first (dirp)) { + /* Directory stream opened successfully */ + error = 0; + } else { + /* Cannot retrieve first entry */ + error = 1; + dirent_set_errno (ENOENT); + } + + } else { + /* Cannot retrieve full path name */ + dirent_set_errno (ENOENT); + error = 1; + } + + } else { + /* Cannot allocate memory for search pattern */ + error = 1; + } + + } else { + /* Cannot allocate _WDIR structure */ + error = 1; + } + + /* Clean up in case of error */ + if (error && dirp) { + _wclosedir (dirp); + dirp = NULL; + } + + return dirp; +} + +/* + * Read next directory entry. The directory entry is returned in dirent + * structure in the d_name field. Individual directory entries returned by + * this function include regular files, sub-directories, pseudo-directories + * "." and ".." as well as volume labels, hidden files and system files. + */ +static struct _wdirent* +_wreaddir( + _WDIR *dirp) +{ + WIN32_FIND_DATAW *datap; + struct _wdirent *entp; + + /* Read next directory entry */ + datap = dirent_next (dirp); + if (datap) { + size_t n; + DWORD attr; + + /* Pointer to directory entry to return */ + entp = &dirp->ent; + + /* + * Copy file name as wide-character string. If the file name is too + * long to fit in to the destination buffer, then truncate file name + * to PATH_MAX characters and zero-terminate the buffer. + */ + n = 0; + while (n < PATH_MAX && datap->cFileName[n] != 0) { + entp->d_name[n] = datap->cFileName[n]; + n++; + } + dirp->ent.d_name[n] = 0; + + /* Length of file name excluding zero terminator */ + entp->d_namlen = n; + + /* File type */ + attr = datap->dwFileAttributes; + if ((attr & FILE_ATTRIBUTE_DEVICE) != 0) { + entp->d_type = DT_CHR; + } else if ((attr & FILE_ATTRIBUTE_DIRECTORY) != 0) { + entp->d_type = DT_DIR; + } else { + entp->d_type = DT_REG; + } + + /* Reset dummy fields */ + entp->d_ino = 0; + entp->d_reclen = sizeof (struct _wdirent); + + } else { + + /* Last directory entry read */ + entp = NULL; + + } + + return entp; +} + +/* + * Close directory stream opened by opendir() function. This invalidates the + * DIR structure as well as any directory entry read previously by + * _wreaddir(). + */ +static int +_wclosedir( + _WDIR *dirp) +{ + int ok; + if (dirp) { + + /* Release search handle */ + if (dirp->handle != INVALID_HANDLE_VALUE) { + FindClose (dirp->handle); + dirp->handle = INVALID_HANDLE_VALUE; + } + + /* Release search pattern */ + if (dirp->patt) { + free (dirp->patt); + dirp->patt = NULL; + } + + /* Release directory structure */ + free (dirp); + ok = /*success*/0; + + } else { + /* Invalid directory stream */ + dirent_set_errno (EBADF); + ok = /*failure*/-1; + } + return ok; +} + +/* + * Rewind directory stream such that _wreaddir() returns the very first + * file name again. + */ +static void +_wrewinddir( + _WDIR* dirp) +{ + if (dirp) { + /* Release existing search handle */ + if (dirp->handle != INVALID_HANDLE_VALUE) { + FindClose (dirp->handle); + } + + /* Open new search handle */ + dirent_first (dirp); + } +} + +/* Get first directory entry (internal) */ +static WIN32_FIND_DATAW* +dirent_first( + _WDIR *dirp) +{ + WIN32_FIND_DATAW *datap; + + /* Open directory and retrieve the first entry */ + dirp->handle = FindFirstFileW (dirp->patt, &dirp->data); + if (dirp->handle != INVALID_HANDLE_VALUE) { + + /* a directory entry is now waiting in memory */ + datap = &dirp->data; + dirp->cached = 1; + + } else { + + /* Failed to re-open directory: no directory entry in memory */ + dirp->cached = 0; + datap = NULL; + + } + return datap; +} + +/* Get next directory entry (internal) */ +static WIN32_FIND_DATAW* +dirent_next( + _WDIR *dirp) +{ + WIN32_FIND_DATAW *p; + + /* Get next directory entry */ + if (dirp->cached != 0) { + + /* A valid directory entry already in memory */ + p = &dirp->data; + dirp->cached = 0; + + } else if (dirp->handle != INVALID_HANDLE_VALUE) { + + /* Get the next directory entry from stream */ + if (FindNextFileW (dirp->handle, &dirp->data) != FALSE) { + /* Got a file */ + p = &dirp->data; + } else { + /* The very last entry has been processed or an error occured */ + FindClose (dirp->handle); + dirp->handle = INVALID_HANDLE_VALUE; + p = NULL; + } + + } else { + + /* End of directory stream reached */ + p = NULL; + + } + + return p; +} + +/* + * Open directory stream using plain old C-string. + */ +static DIR* +opendir( + const char *dirname) +{ + struct DIR *dirp; + int error; + + /* Must have directory name */ + if (dirname == NULL || dirname[0] == '\0') { + dirent_set_errno (ENOENT); + return NULL; + } + + /* Allocate memory for DIR structure */ + dirp = (DIR*) malloc (sizeof (struct DIR)); + if (dirp) { + wchar_t wname[PATH_MAX + 1]; + size_t n; + + /* Convert directory name to wide-character string */ + error = dirent_mbstowcs_s( + &n, wname, PATH_MAX + 1, dirname, PATH_MAX); + if (!error) { + + /* Open directory stream using wide-character name */ + dirp->wdirp = _wopendir (wname); + if (dirp->wdirp) { + /* Directory stream opened */ + error = 0; + } else { + /* Failed to open directory stream */ + error = 1; + } + + } else { + /* + * Cannot convert file name to wide-character string. This + * occurs if the string contains invalid multi-byte sequences or + * the output buffer is too small to contain the resulting + * string. + */ + error = 1; + } + + } else { + /* Cannot allocate DIR structure */ + error = 1; + } + + /* Clean up in case of error */ + if (error && dirp) { + free (dirp); + dirp = NULL; + } + + return dirp; +} + +/* + * Read next directory entry. + * + * When working with text consoles, please note that file names returned by + * readdir() are represented in the default ANSI code page while any output to + * console is typically formatted on another code page. Thus, non-ASCII + * characters in file names will not usually display correctly on console. The + * problem can be fixed in two ways: (1) change the character set of console + * to 1252 using chcp utility and use Lucida Console font, or (2) use + * _cprintf function when writing to console. The _cprinf() will re-encode + * ANSI strings to the console code page so many non-ASCII characters will + * display correcly. + */ +static struct dirent* +readdir( + DIR *dirp) +{ + WIN32_FIND_DATAW *datap; + struct dirent *entp; + + /* Read next directory entry */ + datap = dirent_next (dirp->wdirp); + if (datap) { + size_t n; + int error; + + /* Attempt to convert file name to multi-byte string */ + error = dirent_wcstombs_s( + &n, dirp->ent.d_name, MAX_PATH + 1, datap->cFileName, MAX_PATH); + + /* + * If the file name cannot be represented by a multi-byte string, + * then attempt to use old 8+3 file name. This allows traditional + * Unix-code to access some file names despite of unicode + * characters, although file names may seem unfamiliar to the user. + * + * Be ware that the code below cannot come up with a short file + * name unless the file system provides one. At least + * VirtualBox shared folders fail to do this. + */ + if (error && datap->cAlternateFileName[0] != '\0') { + error = dirent_wcstombs_s( + &n, dirp->ent.d_name, MAX_PATH + 1, datap->cAlternateFileName, + sizeof (datap->cAlternateFileName) / + sizeof (datap->cAlternateFileName[0])); + } + + if (!error) { + DWORD attr; + + /* Initialize directory entry for return */ + entp = &dirp->ent; + + /* Length of file name excluding zero terminator */ + entp->d_namlen = n - 1; + + /* File attributes */ + attr = datap->dwFileAttributes; + if ((attr & FILE_ATTRIBUTE_DEVICE) != 0) { + entp->d_type = DT_CHR; + } else if ((attr & FILE_ATTRIBUTE_DIRECTORY) != 0) { + entp->d_type = DT_DIR; + } else { + entp->d_type = DT_REG; + } + + /* Reset dummy fields */ + entp->d_ino = 0; + entp->d_reclen = sizeof (struct dirent); + + } else { + /* + * Cannot convert file name to multi-byte string so construct + * an errornous directory entry and return that. Note that + * we cannot return NULL as that would stop the processing + * of directory entries completely. + */ + entp = &dirp->ent; + entp->d_name[0] = '?'; + entp->d_name[1] = '\0'; + entp->d_namlen = 1; + entp->d_type = DT_UNKNOWN; + entp->d_ino = 0; + entp->d_reclen = 0; + } + + } else { + /* No more directory entries */ + entp = NULL; + } + + return entp; +} + +/* + * Close directory stream. + */ +static int +closedir( + DIR *dirp) +{ + int ok; + if (dirp) { + + /* Close wide-character directory stream */ + ok = _wclosedir (dirp->wdirp); + dirp->wdirp = NULL; + + /* Release multi-byte character version */ + free (dirp); + + } else { + + /* Invalid directory stream */ + dirent_set_errno (EBADF); + ok = /*failure*/-1; + + } + return ok; +} + +/* + * Rewind directory stream to beginning. + */ +static void +rewinddir( + DIR* dirp) +{ + /* Rewind wide-character string directory stream */ + _wrewinddir (dirp->wdirp); +} + +/* Convert multi-byte string to wide character string */ +static int +dirent_mbstowcs_s( + size_t *pReturnValue, + wchar_t *wcstr, + size_t sizeInWords, + const char *mbstr, + size_t count) +{ + int error; + +#if defined(_MSC_VER) && _MSC_VER >= 1400 + + /* Microsoft Visual Studio 2005 or later */ + error = mbstowcs_s (pReturnValue, wcstr, sizeInWords, mbstr, count); + +#else + + /* Older Visual Studio or non-Microsoft compiler */ + size_t n; + + /* Convert to wide-character string */ + n = mbstowcs (wcstr, mbstr, count); + if (n < sizeInWords) { + + /* Zero-terminate output buffer */ + if (wcstr) { + wcstr[n] = 0; + } + + /* Length of resuting multi-byte string WITH zero terminator */ + if (pReturnValue) { + *pReturnValue = n + 1; + } + + /* Success */ + error = 0; + + } else { + + /* Could not convert string */ + error = 1; + + } + +#endif + + return error; +} + +/* Convert wide-character string to multi-byte string */ +static int +dirent_wcstombs_s( + size_t *pReturnValue, + char *mbstr, + size_t sizeInBytes, + const wchar_t *wcstr, + size_t count) +{ + int error; + +#if defined(_MSC_VER) && _MSC_VER >= 1400 + + /* Microsoft Visual Studio 2005 or later */ + error = wcstombs_s (pReturnValue, mbstr, sizeInBytes, wcstr, count); + +#else + + /* Older Visual Studio or non-Microsoft compiler */ + size_t n; + + /* Convert to multi-byte string */ + n = wcstombs (mbstr, wcstr, count); + if (n < sizeInBytes) { + + /* Zero-terminate output buffer */ + if (mbstr) { + mbstr[n] = '\0'; + } + + /* Lenght of resulting multi-bytes string WITH zero-terminator */ + if (pReturnValue) { + *pReturnValue = n + 1; + } + + /* Success */ + error = 0; + + } else { + + /* Cannot convert string */ + error = 1; + + } + +#endif + + return error; +} + +/* Set errno variable */ +static void +dirent_set_errno( + int error) +{ +#if defined(_MSC_VER) + + /* Microsoft Visual Studio */ + _set_errno (error); + +#else + + /* Non-Microsoft compiler */ + errno = error; + +#endif +} + + +#ifdef __cplusplus +} +#endif + +#ifdef _MSC_VER + #pragma warning (pop) +#endif + +#endif /*DIRENT_H*/ diff --git a/source/cppfs/source/fs.cpp b/source/cppfs/source/fs.cpp index d552c3a..1bd31d7 100644 --- a/source/cppfs/source/fs.cpp +++ b/source/cppfs/source/fs.cpp @@ -25,15 +25,17 @@ #include #ifdef SYSTEM_WINDOWS + #include + #include #else + #include + #include #endif -namespace cppfs -{ -namespace fs +namespace cppfs { namespace fs { @@ -145,6 +147,14 @@ std::string hashToString(const unsigned char * hash) return stream.str(); } +int makeDir(const std::string & path) +{ +#ifdef WIN32 + return _mkdir(path.c_str()); +#else + return mkdir(path.c_str(), 0755); +#endif +} + -} // namespace fs -} // namespace cppfs +}} // namespace cppfs::fs diff --git a/source/tests/cppfs-test/CMakeLists.txt b/source/tests/cppfs-test/CMakeLists.txt index 3cb31e9..21c3675 100644 --- a/source/tests/cppfs-test/CMakeLists.txt +++ b/source/tests/cppfs-test/CMakeLists.txt @@ -22,6 +22,7 @@ message(STATUS "Test ${target}") set(sources main.cpp cppfs_test.cpp + FilePath_test.cpp ) diff --git a/source/tests/cppfs-test/FilePath_test.cpp b/source/tests/cppfs-test/FilePath_test.cpp new file mode 100644 index 0000000..797375d --- /dev/null +++ b/source/tests/cppfs-test/FilePath_test.cpp @@ -0,0 +1,151 @@ + +#include + +#include + + +using namespace cppfs; + + +class FilePath_test : public testing::Test +{ +public: + FilePath_test() + { + } +}; + + +TEST_F(FilePath_test, originalPath) +{ + const auto unixPath = "/home/user/path/to/file.ext"; + const auto winPath = "C:\\User\\Path\\To\\File.ext"; + + auto unixFilePath = FilePath(unixPath); + auto winFilePath = FilePath(winPath); + + EXPECT_EQ(unixPath, unixFilePath.originalPath()); + EXPECT_EQ(winPath, winFilePath.originalPath()); + + unixFilePath.setPath("/home/user/path/"); + EXPECT_EQ("/home/user/path/", unixFilePath.originalPath()); +} + +TEST_F(FilePath_test, path) +{ + const auto unixPath = "/home/user/path/to/file.ext"; + const auto winPath = "C:\\User\\Path\\To\\File.ext"; + + auto unixFilePath = FilePath(unixPath); + auto winFilePath = FilePath(winPath); + + EXPECT_EQ(unixPath, unixFilePath.path()); + EXPECT_EQ("C:/User/Path/To/File.ext", winFilePath.path()); + + unixFilePath.setPath("/home/user/path/"); + EXPECT_EQ("/home/user/path/", unixFilePath.path()); + EXPECT_EQ("/home/user/path", unixFilePath.fullPath()); +} + +TEST_F(FilePath_test, setPath) +{ + auto filePath = FilePath("/home/user/path/to/file.ext"); + filePath.setPath("/another/path/"); + + EXPECT_EQ("/another/path/", filePath.originalPath()); + EXPECT_EQ("/another/path/", filePath.path()); + EXPECT_EQ("/another/path", filePath.fullPath()); +} + +TEST_F(FilePath_test, baseName) +{ + auto unixFilePath = FilePath("/home/user/path/to/file.ext"); + auto winFilePath = FilePath("C:\\User\\Path\\To\\File.ext"); + + EXPECT_EQ("file", unixFilePath.baseName()); + EXPECT_EQ("File", winFilePath.baseName()); + + unixFilePath.setPath("/home/user/path/to/.file.ext"); + EXPECT_EQ(".file", unixFilePath.baseName()); + + unixFilePath.setPath("/home/user/path/to/directory"); + EXPECT_EQ("directory", unixFilePath.baseName()); + + unixFilePath.setPath("/home/user/path/to/directory/"); + EXPECT_EQ("directory", unixFilePath.baseName()); + + unixFilePath.setPath("/home/user/path/to/directory.ext/"); + EXPECT_EQ("directory", unixFilePath.baseName()); +} + +TEST_F(FilePath_test, fileName) +{ + auto unixFilePath = FilePath("/home/user/path/to/file.ext"); + auto winFilePath = FilePath("C:\\User\\Path\\To\\File.ext"); + + EXPECT_EQ("file.ext", unixFilePath.fileName()); + EXPECT_EQ("File.ext", winFilePath.fileName()); + + unixFilePath.setPath("/home/user/path/to/.file.ext"); + EXPECT_EQ(".file.ext", unixFilePath.fileName()); + + unixFilePath.setPath("/home/user/path/to/directory"); + EXPECT_EQ("directory", unixFilePath.fileName()); + + unixFilePath.setPath("/home/user/path/to/directory/"); + EXPECT_EQ("directory", unixFilePath.fileName()); + + unixFilePath.setPath("/home/user/path/to/directory.ext/"); + EXPECT_EQ("directory.ext", unixFilePath.fileName()); +} + +TEST_F(FilePath_test, extension) +{ + auto unixFilePath = FilePath("/home/user/path/to/file.ext"); + auto winFilePath = FilePath("C:\\User\\Path\\To\\File.ext"); + + EXPECT_EQ(".ext", unixFilePath.extension()); + EXPECT_EQ(".ext", winFilePath.extension()); + + unixFilePath.setPath("/home/user/path/to/directory/"); + EXPECT_EQ("", unixFilePath.extension()); + + unixFilePath.setPath("/home/user/path/to/file"); + EXPECT_EQ("", unixFilePath.extension()); +} + +TEST_F(FilePath_test, directoryPath) +{ + auto unixFilePath = FilePath("/home/user/path/to/file.ext"); + auto winFilePath = FilePath("C:\\User\\Path\\To\\File.ext"); + + EXPECT_EQ("/home/user/path/to/", unixFilePath.directoryPath()); + EXPECT_EQ("C:/User/Path/To/", winFilePath.directoryPath()); + + unixFilePath.setPath("/home/user/path/to/directory"); + EXPECT_EQ("/home/user/path/to/", unixFilePath.directoryPath()); + + unixFilePath.setPath("/home/user/path/to/directory/"); + EXPECT_EQ("/home/user/path/to/", unixFilePath.directoryPath()); +} + +TEST_F(FilePath_test, driveLetter) +{ + auto unixFilePath = FilePath("/home/user/path/to/file.ext"); + auto winFilePath = FilePath("C:\\User\\Path\\To\\File.ext"); + + EXPECT_EQ("", unixFilePath.driveLetter()); + EXPECT_EQ("C:", winFilePath.driveLetter()); +} + +TEST_F(FilePath_test, directoryPathPlusFileName) +{ + const auto unixPath = "/home/user/path/to/file.ext"; + const auto winPath = "C:\\User\\Path\\To\\File.ext"; + + auto unixFilePath = FilePath(unixPath); + auto winFilePath = FilePath(winPath); + + EXPECT_EQ(unixPath, unixFilePath.directoryPath() + unixFilePath.fileName()); + EXPECT_EQ("C:/User/Path/To/File.ext", winFilePath.directoryPath() + winFilePath.fileName()); +}