summaryrefslogtreecommitdiff
path: root/src/fs/FileSystem.hxx
blob: 4dbb064cb034a7df34e799a582de95dc18b285a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * Copyright (C) 2003-2014 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 "Traits.hxx"
#include "system/fd_util.h"

#include "Path.hxx"

#include <sys/stat.h>
#include <unistd.h>
#include <stdio.h>

class AllocatedPath;

namespace FOpenMode {
	/**
	 * Open mode for reading text files.
	 */
	constexpr PathTraitsFS::const_pointer ReadText = "r";

	/**
	 * Open mode for reading binary files.
	 */
	constexpr PathTraitsFS::const_pointer ReadBinary = "rb";

	/**
	 * Open mode for writing text files.
	 */
	constexpr PathTraitsFS::const_pointer WriteText = "w";

	/**
	 * Open mode for writing binary files.
	 */
	constexpr PathTraitsFS::const_pointer WriteBinary = "wb";

	/**
	 * Open mode for appending text files.
	 */
	constexpr PathTraitsFS::const_pointer AppendText = "a";

	/**
	 * Open mode for appending binary files.
	 */
	constexpr PathTraitsFS::const_pointer AppendBinary = "ab";
}

/**
 * Wrapper for fopen() that uses #Path names.
 */
static inline FILE *
FOpen(Path file, PathTraitsFS::const_pointer mode)
{
	return fopen(file.c_str(), mode);
}

/**
 * Wrapper for open_cloexec() that uses #Path names.
 */
static inline int
OpenFile(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(Path oldpath, Path newpath)
{
	return rename(oldpath.c_str(), newpath.c_str()) == 0;
}

/**
 * Wrapper for stat() that uses #Path names.
 */
static inline bool
StatFile(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(Path file)
{
	return unlink(file.c_str()) == 0;
}

/**
 * Wrapper for readlink() that uses #Path names.
 */
AllocatedPath
ReadLink(Path path);

#ifndef WIN32

static inline bool
MakeFifo(Path path, mode_t mode)
{
	return mkfifo(path.c_str(), mode) == 0;
}

/**
 * Wrapper for access() that uses #Path names.
 */
static inline bool
CheckAccess(Path path, int mode)
{
	return access(path.c_str(), mode) == 0;
}

#endif

/**
 * Checks is specified path exists and accessible.
 */
static inline bool
CheckAccess(Path path)
{
#ifdef WIN32
	struct stat buf;
	return StatFile(path, buf);
#else
	return CheckAccess(path, F_OK);
#endif
}

/**
 * Checks if #Path exists and is a regular file.
 */
static inline bool
FileExists(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(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(Path path, bool follow_symlinks = true)
{
	struct stat buf;
	return StatFile(path, buf, follow_symlinks);
}

#endif