From 4ad90e2d523f53fbfb3cbab7bc97aa01ce50ae63 Mon Sep 17 00:00:00 2001 From: Denis Krjuchkov Date: Mon, 21 Jan 2013 23:56:40 +0600 Subject: FileSystem: extract DirectoryReader, improve the rest - DirectoryReader is extracted to separate header - FileSystem.cxx/FileSystem.hxx/DirectoryReader.hxx moved to fs/ subdir - Functions return true on success, instead of 0 (where applicable) - ReadLink return result instead of out parameter - UnlinkFile is renamed to RemoveFile - CheckExists/CheckIsRegular/CheckIsDirectory are renamed to PathExists/FileExists/DirectoryExists --- src/fs/DirectoryReader.hxx | 87 ++++++++++++++++++++++++++ src/fs/FileSystem.cxx | 43 +++++++++++++ src/fs/FileSystem.hxx | 153 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 283 insertions(+) create mode 100644 src/fs/DirectoryReader.hxx create mode 100644 src/fs/FileSystem.cxx create mode 100644 src/fs/FileSystem.hxx (limited to 'src/fs') diff --git a/src/fs/DirectoryReader.hxx b/src/fs/DirectoryReader.hxx new file mode 100644 index 000000000..caa1e90ec --- /dev/null +++ b/src/fs/DirectoryReader.hxx @@ -0,0 +1,87 @@ +/* + * Copyright (C) 2003-2013 The Music Player Daemon Project + * http://www.musicpd.org + * + * 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. + */ + +#ifndef MPD_FS_DIRECTORY_READER_HXX +#define MPD_FS_DIRECTORY_READER_HXX + +#include "check.h" +#include "Path.hxx" + +#include + +/** + * Reader for directory entries. + */ +class DirectoryReader { + DIR *const dirp; + dirent *ent; +public: + /** + * Creates new directory reader for the specified #dir. + */ + explicit DirectoryReader(const Path &dir) + : dirp(opendir(dir.c_str())), + ent(nullptr) { + } + + DirectoryReader(const DirectoryReader &other) = delete; + DirectoryReader &operator=(const DirectoryReader &other) = delete; + + /** + * Destroys this instance. + */ + ~DirectoryReader() { + if (!Failed()) + closedir(dirp); + } + + /** + * Checks if directory failed to open. + */ + bool Failed() const { + return dirp == nullptr; + } + + /** + * Checks if directory entry is available. + */ + bool HasEntry() const { + assert(!Failed()); + return ent != nullptr; + } + + /** + * Reads next directory entry. + */ + bool ReadEntry() { + assert(!Failed()); + ent = readdir(dirp); + return HasEntry(); + } + + /** + * Extracts directory entry that was previously read by #ReadEntry. + */ + Path GetEntry() const { + assert(HasEntry()); + return Path::FromFS(ent->d_name); + } +}; + +#endif diff --git a/src/fs/FileSystem.cxx b/src/fs/FileSystem.cxx new file mode 100644 index 000000000..70ab01fbd --- /dev/null +++ b/src/fs/FileSystem.cxx @@ -0,0 +1,43 @@ +/* + * Copyright (C) 2003-2013 The Music Player Daemon Project + * http://www.musicpd.org + * + * 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. + */ + +#include "config.h" +#include "FileSystem.hxx" + +#include + +Path ReadLink(const Path &path) +{ +#ifdef WIN32 + (void)path; + errno = EINVAL; + return Path::Null(); +#else + char buffer[MPD_PATH_MAX]; + ssize_t size = readlink(path.c_str(), buffer, MPD_PATH_MAX); + if (size < 0) + return Path::Null(); + if (size >= MPD_PATH_MAX) { + errno = ENOMEM; + return Path::Null(); + } + buffer[size] = '\0'; + return Path::FromFS(buffer); +#endif +} diff --git a/src/fs/FileSystem.hxx b/src/fs/FileSystem.hxx new file mode 100644 index 000000000..93365ecb4 --- /dev/null +++ b/src/fs/FileSystem.hxx @@ -0,0 +1,153 @@ +/* + * Copyright (C) 2003-2013 The Music Player Daemon Project + * http://www.musicpd.org + * + * 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. + */ + +#ifndef MPD_FS_FILESYSTEM_HXX +#define MPD_FS_FILESYSTEM_HXX + +#include "check.h" +#include "fd_util.h" + +#include "Path.hxx" + +#include +#include +#include +#include + +namespace FOpenMode { +/** + * Open mode for reading text files. + */ +constexpr Path::const_pointer ReadText = "r"; + +/** + * Open mode for reading binary files. + */ +constexpr Path::const_pointer ReadBinary = "rb"; + +/** + * Open mode for writing text files. + */ +constexpr Path::const_pointer WriteText = "w"; + +/** + * Open mode for writing binary files. + */ +constexpr Path::const_pointer WriteBinary = "wb"; +} + +/** + * Wrapper for fopen() that uses #Path names. + */ +static inline FILE *FOpen(const Path &file, Path::const_pointer mode) +{ + return fopen(file.c_str(), mode); +} + +/** + * Wrapper for open_cloexec() that uses #Path names. + */ +static inline int OpenFile(const Path &file, int flags, int mode) +{ + return open_cloexec(file.c_str(), flags, mode); +} + +/** + * Wrapper for rename() that uses #Path names. + */ +static inline bool RenameFile(const Path &oldpath, const Path &newpath) +{ + return rename(oldpath.c_str(), newpath.c_str()) == 0; +} + +/** + * Wrapper for stat() that uses #Path names. + */ +static inline bool StatFile(const Path &file, struct stat &buf, + bool follow_symlinks = true) +{ +#ifdef WIN32 + (void)follow_symlinks; + return stat(file.c_str(), &buf) == 0; +#else + int ret = follow_symlinks + ? stat(file.c_str(), &buf) + : lstat(file.c_str(), &buf); + return ret == 0; +#endif +} + +/** + * Wrapper for unlink() that uses #Path names. + */ +static inline bool RemoveFile(const Path &file) +{ + return unlink(file.c_str()) == 0; +} + +/** + * Wrapper for readlink() that uses #Path names. + */ +Path ReadLink(const Path &path); + +/** + * Wrapper for access() that uses #Path names. + */ +static inline bool CheckAccess(const Path &path, int mode) +{ +#ifdef WIN32 + (void)path; + (void)mode; + return true; +#else + return access(path.c_str(), mode) == 0; +#endif +} + +/** + * Checks if #Path exists and is a regular file. + */ +static inline bool FileExists(const Path &path, + bool follow_symlinks = true) +{ + struct stat buf; + return StatFile(path, buf, follow_symlinks) && S_ISREG(buf.st_mode); +} + +/** + * Checks if #Path exists and is a directory. + */ +static inline bool DirectoryExists(const Path &path, + bool follow_symlinks = true) +{ + struct stat buf; + return StatFile(path, buf, follow_symlinks) && S_ISDIR(buf.st_mode); +} + +/** + * Checks if #Path exists. + */ +static inline bool PathExists(const Path &path, + bool follow_symlinks = true) +{ + struct stat buf; + return StatFile(path, buf, follow_symlinks); +} + +#endif -- cgit v1.2.3