aboutsummaryrefslogtreecommitdiffstats
path: root/src/fs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/fs/DirectoryReader.hxx87
-rw-r--r--src/fs/FileSystem.cxx43
-rw-r--r--src/fs/FileSystem.hxx163
-rw-r--r--src/fs/Path.cxx150
-rw-r--r--src/fs/Path.hxx267
5 files changed, 710 insertions, 0 deletions
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 <dirent.h>
+
+/**
+ * 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 <errno.h>
+
+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..2e1701c87
--- /dev/null
+++ b/src/fs/FileSystem.hxx
@@ -0,0 +1,163 @@
+/*
+ * 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 <sys/stat.h>
+#include <unistd.h>
+#include <assert.h>
+#include <stdio.h>
+
+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";
+
+/**
+ * Open mode for appending text files.
+ */
+constexpr Path::const_pointer AppendText = "a";
+
+/**
+ * Open mode for appending binary files.
+ */
+constexpr Path::const_pointer AppendBinary = "ab";
+}
+
+/**
+ * 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
diff --git a/src/fs/Path.cxx b/src/fs/Path.cxx
new file mode 100644
index 000000000..cb808b36c
--- /dev/null
+++ b/src/fs/Path.cxx
@@ -0,0 +1,150 @@
+/*
+ * 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 "fs/Path.hxx"
+#include "conf.h"
+#include "mpd_error.h"
+#include "gcc.h"
+
+#include <glib.h>
+
+#include <assert.h>
+#include <string.h>
+
+#ifdef G_OS_WIN32
+#include <windows.h> // for GetACP()
+#include <stdio.h> // for sprintf()
+#endif
+
+#undef G_LOG_DOMAIN
+#define G_LOG_DOMAIN "path"
+
+/**
+ * Maximal number of bytes required to represent path name in UTF-8
+ * (including nul-terminator).
+ * This value is a rought estimate of upper bound.
+ * It's based on path name limit in bytes (MPD_PATH_MAX)
+ * and assumption that some weird encoding could represent some UTF-8 4 byte
+ * sequences with single byte.
+ */
+#define MPD_PATH_MAX_UTF8 ((MPD_PATH_MAX - 1) * 4 + 1)
+
+std::string fs_charset;
+
+std::string Path::ToUTF8(const_pointer path_fs)
+{
+ if (path_fs == nullptr)
+ return std::string();
+
+ GIConv conv = g_iconv_open("utf-8", fs_charset.c_str());
+ if (conv == reinterpret_cast<GIConv>(-1))
+ return std::string();
+
+ // g_iconv() does not need nul-terminator,
+ // std::string could be created without it too.
+ char path_utf8[MPD_PATH_MAX_UTF8 - 1];
+ char *in = const_cast<char *>(path_fs);
+ char *out = path_utf8;
+ size_t in_left = strlen(path_fs);
+ size_t out_left = sizeof(path_utf8);
+
+ size_t ret = g_iconv(conv, &in, &in_left, &out, &out_left);
+
+ g_iconv_close(conv);
+
+ if (ret == static_cast<size_t>(-1) || in_left > 0)
+ return std::string();
+
+ return std::string(path_utf8, sizeof(path_utf8) - out_left);
+}
+
+Path Path::FromUTF8(const char *path_utf8)
+{
+ gchar *p;
+
+ p = g_convert(path_utf8, -1,
+ fs_charset.c_str(), "utf-8",
+ NULL, NULL, NULL);
+
+ return Path(Donate(), p);
+}
+
+gcc_pure
+static bool
+IsSupportedCharset(const char *charset)
+{
+ /* convert a space to check if the charset is valid */
+ char *test = g_convert(" ", 1, charset, "UTF-8", NULL, NULL, NULL);
+ if (test == NULL)
+ return false;
+
+ g_free(test);
+ return true;
+}
+
+static void
+SetFSCharset(const char *charset)
+{
+ assert(charset != NULL);
+
+ if (!IsSupportedCharset(charset))
+ MPD_ERROR("invalid filesystem charset: %s", charset);
+
+ fs_charset = charset;
+
+ g_debug("SetFSCharset: fs charset is: %s", fs_charset.c_str());
+}
+
+const std::string &Path::GetFSCharset()
+{
+ return fs_charset;
+}
+
+void Path::GlobalInit()
+{
+ const char *charset = NULL;
+
+ charset = config_get_string(CONF_FS_CHARSET, NULL);
+ if (charset == NULL) {
+#ifndef G_OS_WIN32
+ const gchar **encodings;
+ g_get_filename_charsets(&encodings);
+
+ if (encodings[0] != NULL && *encodings[0] != '\0')
+ charset = encodings[0];
+#else /* G_OS_WIN32 */
+ /* Glib claims that file system encoding is always utf-8
+ * on native Win32 (i.e. not Cygwin).
+ * However this is true only if <gstdio.h> helpers are used.
+ * MPD uses regular <stdio.h> functions.
+ * Those functions use encoding determined by GetACP(). */
+ static char win_charset[13];
+ sprintf(win_charset, "cp%u", GetACP());
+ charset = win_charset;
+#endif
+ }
+
+ if (charset) {
+ SetFSCharset(charset);
+ } else {
+ g_message("setting filesystem charset to ISO-8859-1");
+ SetFSCharset("ISO-8859-1");
+ }
+}
diff --git a/src/fs/Path.hxx b/src/fs/Path.hxx
new file mode 100644
index 000000000..eaab2bde5
--- /dev/null
+++ b/src/fs/Path.hxx
@@ -0,0 +1,267 @@
+/*
+ * 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_PATH_HXX
+#define MPD_FS_PATH_HXX
+
+#include "check.h"
+#include "gcc.h"
+
+#include <glib.h>
+
+#include <algorithm>
+#include <string>
+
+#include <assert.h>
+#include <string.h>
+#include <limits.h>
+
+#if !defined(MPD_PATH_MAX)
+# if defined(WIN32)
+# define MPD_PATH_MAX 260
+# elif defined(MAXPATHLEN)
+# define MPD_PATH_MAX MAXPATHLEN
+# elif defined(PATH_MAX)
+# define MPD_PATH_MAX PATH_MAX
+# else
+# define MPD_PATH_MAX 256
+# endif
+#endif
+
+/**
+ * A path name in the native file system character set.
+ */
+class Path {
+public:
+ typedef char value_type;
+ typedef value_type *pointer;
+ typedef const value_type *const_pointer;
+
+private:
+ pointer value;
+
+ struct Donate {};
+
+ /**
+ * Donate the allocated pointer to a new #Path object.
+ */
+ constexpr Path(Donate, pointer _value):value(_value) {}
+
+ /**
+ * Release memory allocated by the value, but do not clear the
+ * value pointer.
+ */
+ void Free() {
+ /* free() can be optimized by gcc, while g_free() can
+ not: when the compiler knows that the value is
+ nullptr, it will not emit a free() call in the
+ inlined destructor; however on Windows, we need to
+ call g_free(), because the value has been allocated
+ by GLib, and on Windows, this matters */
+#ifdef WIN32
+ g_free(value);
+#else
+ free(value);
+#endif
+ }
+
+public:
+ /**
+ * Copy a #Path object.
+ */
+ Path(const Path &other)
+ :value(g_strdup(other.value)) {}
+
+ /**
+ * Move a #Path object.
+ */
+ Path(Path &&other):value(other.value) {
+ other.value = nullptr;
+ }
+
+ ~Path() {
+ Free();
+ }
+
+ /**
+ * Return a "nulled" instance. Its IsNull() method will
+ * return true. Such an object must not be used.
+ *
+ * @see IsNull()
+ */
+ gcc_const
+ static Path Null() {
+ return Path(Donate(), nullptr);
+ }
+
+ /**
+ * Join two path components with the path separator.
+ */
+ gcc_pure gcc_nonnull_all
+ static Path Build(const_pointer a, const_pointer b) {
+ return Path(Donate(), g_build_filename(a, b, nullptr));
+ }
+
+ gcc_pure gcc_nonnull_all
+ static Path Build(const_pointer a, const Path &b) {
+ return Build(a, b.c_str());
+ }
+
+ gcc_pure gcc_nonnull_all
+ static Path Build(const Path &a, const_pointer b) {
+ return Build(a.c_str(), b);
+ }
+
+ gcc_pure
+ static Path Build(const Path &a, const Path &b) {
+ return Build(a.c_str(), b.c_str());
+ }
+
+ /**
+ * Convert a C string that is already in the filesystem
+ * character set to a #Path instance.
+ */
+ gcc_pure
+ static Path FromFS(const_pointer fs) {
+ return Path(Donate(), g_strdup(fs));
+ }
+
+ /**
+ * Convert a UTF-8 C string to a #Path instance.
+ * Returns return a "nulled" instance on error.
+ */
+ gcc_pure
+ static Path FromUTF8(const char *path_utf8);
+
+ /**
+ * Convert the path to UTF-8.
+ * Returns empty string on error or if #path_fs is null pointer.
+ */
+ gcc_pure
+ static std::string ToUTF8(const_pointer path_fs);
+
+ /**
+ * Performs global one-time initialization of this class.
+ */
+ static void GlobalInit();
+
+ /**
+ * Gets file system character set name.
+ */
+ static const std::string &GetFSCharset();
+
+ /**
+ * Copy a #Path object.
+ */
+ Path &operator=(const Path &other) {
+ if (this != &other) {
+ Free();
+ value = g_strdup(other.value);
+ }
+
+ return *this;
+ }
+
+ /**
+ * Move a #Path object.
+ */
+ Path &operator=(Path &&other) {
+ std::swap(value, other.value);
+ return *this;
+ }
+
+ /**
+ * Steal the allocated value. This object has an undefined
+ * value, and the caller is response for freeing this method's
+ * return value.
+ */
+ pointer Steal() {
+ pointer result = value;
+ value = nullptr;
+ return result;
+ }
+
+ /**
+ * Check if this is a "nulled" instance. A "nulled" instance
+ * must not be used.
+ */
+ bool IsNull() const {
+ return value == nullptr;
+ }
+
+ /**
+ * Clear this object's value, make it "nulled".
+ *
+ * @see IsNull()
+ */
+ void SetNull() {
+ Free();
+ value = nullptr;
+ }
+
+ gcc_pure
+ bool empty() const {
+ assert(value != nullptr);
+
+ return *value == 0;
+ }
+
+ /**
+ * @return the length of this string in number of "value_type"
+ * elements (which may not be the number of characters).
+ */
+ gcc_pure
+ size_t length() const {
+ assert(value != nullptr);
+
+ return strlen(value);
+ }
+
+ /**
+ * Returns the value as a const C string. The returned
+ * pointer is invalidated whenever the value of life of this
+ * instance ends.
+ */
+ gcc_pure
+ const_pointer c_str() const {
+ assert(value != nullptr);
+
+ return value;
+ }
+
+ /**
+ * Convert the path to UTF-8.
+ * Returns empty string on error or if this instance is "nulled"
+ * (#IsNull returns true).
+ */
+ std::string ToUTF8() const {
+ return ToUTF8(value);
+ }
+
+ /**
+ * Gets directory name of this path.
+ * Returns a "nulled" instance on error.
+ */
+ Path GetDirectoryName() const {
+ assert(value != nullptr);
+ return Path(Donate(), g_path_get_dirname(value));
+ }
+};
+
+#endif