Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 315 lines (278 sloc) 10.683 kB
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
1 // Copyright (C) 2012 Henner Zeller <h.zeller@acm.org>
2 //
3 // This program is free software; you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation; either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // This program is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with this program. If not, see <http://www.gnu.org/licenses/>.
15
16 // Use latest version.
17 #define FUSE_USE_VERSION 26
18 #include <fuse.h>
a9d3e53 @hzeller o Found a project name: "Folve". Some renamings because of that.
authored
19
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
20 #include <dirent.h>
21 #include <errno.h>
b698853 @hzeller o README updates.
authored
22 #include <fcntl.h>
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
23 #include <limits.h>
b698853 @hzeller o README updates.
authored
24 #include <stdio.h>
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
25 #include <stdlib.h>
b698853 @hzeller o README updates.
authored
26 #include <string.h>
27 #include <sys/stat.h>
28 #include <sys/time.h>
49eca7f @hzeller o add syslog as preparation for parameter handling.
authored
29 #include <syslog.h>
b698853 @hzeller o README updates.
authored
30 #include <unistd.h>
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
31
a9d3e53 @hzeller o Found a project name: "Folve". Some renamings because of that.
authored
32 #include "folve-filesystem.h"
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
33 #include "status-server.h"
7689c9a @hzeller o preparation to extract classes from folve-filesystem into their
authored
34 #include "util.h"
e9c07dd @hzeller o add documentation
authored
35
6c6dedb @hzeller o Some readme tweaks and readability improvements.
authored
36 // Compilation unit variables to communicate with the fuse callbacks.
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
37 static struct FolveRuntime {
a372a03 @hzeller o Make meta-refresh configurable.
authored
38 FolveRuntime() : fs(NULL), mount_point(NULL),
fa525ee @hzeller o If we find problems in the options, complain and exit.
authored
39 status_port(-1), refresh_time(10), parameter_error(false) {}
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
40 FolveFilesystem *fs;
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
41 const char *mount_point;
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
42 int status_port;
a372a03 @hzeller o Make meta-refresh configurable.
authored
43 int refresh_time;
fa525ee @hzeller o If we find problems in the options, complain and exit.
authored
44 bool parameter_error;
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
45 } folve_rt;
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
46
7c7bda6 @hzeller o attempt to create a sndfile for every file, if that fails, fall
authored
47 static char *concat_path(char *buf, const char *a, const char *b) {
48 strcpy(buf, a);
49 strcat(buf, b);
50 return buf;
51 }
52
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
53 // Given a relative path from the root of the mounted file-system, get the
54 // original file from the source filesystem.
55 static const char *assemble_orig_path(char *buf, const char *path) {
08bbf28 @hzeller o First shot at gapless. Works pretty well for my test-case.
authored
56 return concat_path(buf, folve_rt.fs->underlying_dir().c_str(), path);
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
57 }
58
7c7bda6 @hzeller o attempt to create a sndfile for every file, if that fails, fall
authored
59 // Essentially lstat(). Just forward to the original filesystem (this
73093dc @hzeller o Keep open file-descriptor.
authored
60 // will by lying: our convolved files are of different size...)
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
61 static int folve_getattr(const char *path, struct stat *stbuf) {
9a8ea56 @hzeller o add infrastructure to provide Stat() output of currently open
authored
62 // If this is a currently open filename, we might be able to output a better
63 // estimate.
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
64 int result = folve_rt.fs->StatByFilename(path, stbuf);
369a0a7 @hzeller o Writing is not possible. Show permissions as readonly.
authored
65 if (result != 0) {
66 char path_buf[PATH_MAX];
67 result = lstat(assemble_orig_path(path_buf, path), stbuf);
68 if (result == -1)
69 return -errno;
70 }
71 // Whatever write mode was there before: now things are readonly.
72 stbuf->st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
73 return 0;
74 }
75
73093dc @hzeller o Keep open file-descriptor.
authored
76 // readdir(). Just forward to original filesystem.
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
77 static int folve_readdir(const char *path, void *buf, fuse_fill_dir_t filler,
78 off_t offset, struct fuse_file_info *fi) {
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
79 DIR *dp;
80 struct dirent *de;
81 char path_buf[PATH_MAX];
82
83 dp = opendir(assemble_orig_path(path_buf, path));
84 if (dp == NULL)
85 return -errno;
86
87 while ((de = readdir(dp)) != NULL) {
88 struct stat st;
89 memset(&st, 0, sizeof(st));
90 st.st_ino = de->d_ino;
91 st.st_mode = de->d_type << 12;
7c7bda6 @hzeller o attempt to create a sndfile for every file, if that fails, fall
authored
92 const char *entry_name = de->d_name;
93 if (filler(buf, entry_name, &st, 0))
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
94 break;
95 }
96
97 closedir(dp);
98 return 0;
99 }
100
73093dc @hzeller o Keep open file-descriptor.
authored
101 // readlink(): forward to original filesystem.
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
102 static int folve_readlink(const char *path, char *buf, size_t size) {
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
103 char path_buf[PATH_MAX];
104 const int result = readlink(assemble_orig_path(path_buf, path),
105 buf, size - 1);
106 if (result == -1)
107 return -errno;
108
109 buf[result] = '\0';
110 return 0;
111 }
112
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
113 static int folve_open(const char *path, struct fuse_file_info *fi) {
8b18938 @hzeller o some comment changes. Ready to do some flac handling.
authored
114 // We want to be allowed to only return part of the requested data in read().
115 // That way, we can separate reading the ID3-tags from
116 // decoding of the music stream - that way indexing should be fast.
117 // Setting the flag 'direct_io' allows us to return partial results.
118 fi->direct_io = 1;
119
e9c07dd @hzeller o add documentation
authored
120 // The file-handle has the neat property to be 64 bit - so we can actually
b698853 @hzeller o README updates.
authored
121 // stuff a pointer to our file handler object in there :)
8b18938 @hzeller o some comment changes. Ready to do some flac handling.
authored
122 // (Yay, someone was thinking while developing that API).
08bbf28 @hzeller o First shot at gapless. Works pretty well for my test-case.
authored
123 FileHandler *handler = folve_rt.fs->GetOrCreateHandler(path);
680f590 @hzeller o report opening error.
authored
124 if (handler == NULL)
125 return -errno;
126 fi->fh = (uint64_t) handler;
127 return 0;
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
128 }
129
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
130 static int folve_read(const char *path, char *buf, size_t size, off_t offset,
131 struct fuse_file_info *fi) {
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
132 return reinterpret_cast<FileHandler *>(fi->fh)->Read(buf, size, offset);
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
133 }
134
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
135 static int folve_release(const char *path, struct fuse_file_info *fi) {
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
136 folve_rt.fs->Close(path, reinterpret_cast<FileHandler *>(fi->fh));
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
137 return 0;
9a8ea56 @hzeller o add infrastructure to provide Stat() output of currently open
authored
138 }
139
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
140 static int folve_fgetattr(const char *path, struct stat *result,
141 struct fuse_file_info *fi) {
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
142 return reinterpret_cast<FileHandler *>(fi->fh)->Stat(result);
73093dc @hzeller o Keep open file-descriptor.
authored
143 }
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
144
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
145 static void *folve_init(struct fuse_conn_info *conn) {
146 const int ident_len = 20;
147 char *ident = (char*) malloc(ident_len); // openlog() keeps reference. Leaks.
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
148 snprintf(ident, ident_len, "folve[%d]", getpid());
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
149 openlog(ident, LOG_CONS|LOG_PERROR, LOG_USER);
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
150 syslog(LOG_INFO, "Version " FOLVE_VERSION " started. "
151 "Serving '%s' on mount point '%s'",
152 folve_rt.fs->underlying_dir().c_str(), folve_rt.mount_point);
7689c9a @hzeller o preparation to extract classes from folve-filesystem into their
authored
153 if (folve::IsDebugLogEnabled()) {
5830c5a @hzeller o Switch logging to syslog()
authored
154 syslog(LOG_INFO, "Debug logging enabled (-D)");
155 }
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
156
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
157 if (folve_rt.status_port > 0) {
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
158 // Need to start status server after we're daemonized.
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
159 StatusServer *status_server = new StatusServer(folve_rt.fs);
160 if (status_server->Start(folve_rt.status_port)) {
a372a03 @hzeller o Make meta-refresh configurable.
authored
161 syslog(LOG_INFO, "HTTP status server on port %d; refresh=%d",
162 folve_rt.status_port, folve_rt.refresh_time);
163 status_server->set_meta_refresh(folve_rt.refresh_time);
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
164 } else {
165 syslog(LOG_ERR, "Couldn't start HTTP server on port %d\n",
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
166 folve_rt.status_port);
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
167 }
168 }
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
169
170 // Some sanity checks.
171 if (folve_rt.fs->config_dirs().size() == 1) {
172 syslog(LOG_NOTICE, "No filter configuration directories given. "
173 "Any files will be just passed through verbatim.");
174 }
175 if (folve_rt.fs->config_dirs().size() > 2 && folve_rt.status_port < 0) {
176 syslog(LOG_WARNING, "Multiple filter configurations given, but no HTTP "
177 "status port. You only can switch filters via the HTTP interface; "
178 "add -p <port>");
179 }
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
180 return NULL;
181 }
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
182
0a3400d @hzeller o Write when we're exiting.
authored
183 static void folve_destroy(void *) {
db66f7d @hzeller o print which directory is serviced.
authored
184 syslog(LOG_INFO, "Exiting.");
0a3400d @hzeller o Write when we're exiting.
authored
185 }
186
b698853 @hzeller o README updates.
authored
187 static int usage(const char *prg) {
5830c5a @hzeller o Switch logging to syslog()
authored
188 printf("usage: %s [options] <original-dir> <mount-point>\n", prg);
189 printf("Options: (in sequence of usefulness)\n"
062a435 @hzeller o change configuration directory wording.
authored
190 "\t-c <cfg-dir> : Convolver configuration directory.\n"
8c7e5c1 @hzeller o Only if -D is given, the debug toggle is active in the UI.
authored
191 "\t You can supply this option multiple times:\n"
1971a4a @hzeller o No more radio buttons.
authored
192 "\t Select on the HTTP status page.\n"
5830c5a @hzeller o Switch logging to syslog()
authored
193 "\t-p <port> : Port to run the HTTP status server on.\n"
436f57d @hzeller o Have a default refresh time of 10 seconds.
authored
194 "\t-r <refresh> : Seconds between refresh of status page;\n"
195 "\t Default is %d seconds; switch off with -1.\n"
f9b9bc9 @hzeller o gapless not experimental anymore.
authored
196 "\t-g : Gapless convolving alphabetically adjacent files.\n"
8c7e5c1 @hzeller o Only if -D is given, the debug toggle is active in the UI.
authored
197 "\t-D : Moderate volume Folve debug messages to syslog.\n"
5830c5a @hzeller o Switch logging to syslog()
authored
198 "\t-f : Operate in foreground; useful for debugging.\n"
199 "\t-o <mnt-opt> : other generic mount parameters passed to fuse.\n"
436f57d @hzeller o Have a default refresh time of 10 seconds.
authored
200 "\t-d : High volume fuse debug log. Implies -f.\n",
201 folve_rt.refresh_time);
8b18938 @hzeller o some comment changes. Ready to do some flac handling.
authored
202 return 1;
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
203 }
204
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
205 struct FolveConfig {
206 FolveConfig() : base_dir(NULL), config_dir(NULL), port(-1) {}
207 const char *base_dir;
208 const char *mount_point;
209 const char *config_dir;
210 int port;
211 };
212
213 enum {
214 FOLVE_OPT_PORT = 42,
a372a03 @hzeller o Make meta-refresh configurable.
authored
215 FOLVE_OPT_REFRESH_TIME,
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
216 FOLVE_OPT_CONFIG,
5830c5a @hzeller o Switch logging to syslog()
authored
217 FOLVE_OPT_DEBUG,
08bbf28 @hzeller o First shot at gapless. Works pretty well for my test-case.
authored
218 FOLVE_OPT_GAPLESS,
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
219 };
220
221 int FolveOptionHandling(void *data, const char *arg, int key,
222 struct fuse_args *outargs) {
df18f63 @hzeller o Make path-names to filters and base-directory absolute
authored
223 char realpath_buf[PATH_MAX]; // running as daemon, need absolute names.
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
224 FolveRuntime *rt = (FolveRuntime*) data;
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
225 switch (key) {
226 case FUSE_OPT_KEY_NONOPT:
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
227 // First non-opt: our underlying dir.
228 if (rt->fs->underlying_dir().empty()) {
cf1b0e0 @hzeller o README demo tweaking
authored
229 const char *base_dir = realpath(arg, realpath_buf);
230 if (base_dir != NULL) {
231 rt->fs->set_underlying_dir(base_dir);
232 } else {
233 fprintf(stderr, "Invalid base path '%s': %s\n",
234 arg, strerror(errno));
fa525ee @hzeller o If we find problems in the options, complain and exit.
authored
235 rt->parameter_error = true;
cf1b0e0 @hzeller o README demo tweaking
authored
236 }
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
237 return 0; // we consumed this.
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
238 } else {
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
239 rt->mount_point = strdup(arg); // remmber as FYI
240 return 1; // .. but leave it to fuse
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
241 }
242 case FOLVE_OPT_PORT:
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
243 rt->status_port = atoi(arg + 2); // strip "-p"
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
244 return 0;
a372a03 @hzeller o Make meta-refresh configurable.
authored
245 case FOLVE_OPT_REFRESH_TIME:
246 rt->refresh_time = atoi(arg + 2); // strip "-r"
247 return 0;
cf1b0e0 @hzeller o README demo tweaking
authored
248 case FOLVE_OPT_CONFIG: {
249 const char *config_dir = realpath(arg + 2, realpath_buf); // strip "-c"
250 if (config_dir != NULL) {
251 rt->fs->add_config_dir(config_dir);
252 } else {
253 fprintf(stderr, "Invalid config dir '%s': %s\n",
254 arg + 2, strerror(errno));
fa525ee @hzeller o If we find problems in the options, complain and exit.
authored
255 rt->parameter_error = true;
cf1b0e0 @hzeller o README demo tweaking
authored
256 }
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
257 return 0;
cf1b0e0 @hzeller o README demo tweaking
authored
258 }
5830c5a @hzeller o Switch logging to syslog()
authored
259 case FOLVE_OPT_DEBUG:
537e34b @hzeller o cleanup UI: no radio buttons anymore, just simple links.
authored
260 // rt->fs->set_debug_ui_enabled(true); // Disabled in status-server.
7689c9a @hzeller o preparation to extract classes from folve-filesystem into their
authored
261 folve::EnableDebugLog(true);
5830c5a @hzeller o Switch logging to syslog()
authored
262 return 0;
08bbf28 @hzeller o First shot at gapless. Works pretty well for my test-case.
authored
263 case FOLVE_OPT_GAPLESS:
264 rt->fs->set_gapless_processing(true);
265 return 0;
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
266 }
267 return 1;
268 }
269
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
270 int main(int argc, char *argv[]) {
1e9ff21 @hzeller o main: report if parameters are not directories.
authored
271 const char *progname = argv[0];
8b18938 @hzeller o some comment changes. Ready to do some flac handling.
authored
272 if (argc < 4) {
1e9ff21 @hzeller o main: report if parameters are not directories.
authored
273 return usage(progname);
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
274 }
49eca7f @hzeller o add syslog as preparation for parameter handling.
authored
275
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
276 folve_rt.fs = new FolveFilesystem();
277
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
278 static struct fuse_opt folve_options[] = {
5830c5a @hzeller o Switch logging to syslog()
authored
279 FUSE_OPT_KEY("-p ", FOLVE_OPT_PORT),
a372a03 @hzeller o Make meta-refresh configurable.
authored
280 FUSE_OPT_KEY("-r ", FOLVE_OPT_REFRESH_TIME),
5830c5a @hzeller o Switch logging to syslog()
authored
281 FUSE_OPT_KEY("-c ", FOLVE_OPT_CONFIG),
282 FUSE_OPT_KEY("-D", FOLVE_OPT_DEBUG),
08bbf28 @hzeller o First shot at gapless. Works pretty well for my test-case.
authored
283 FUSE_OPT_KEY("-g", FOLVE_OPT_GAPLESS),
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
284 FUSE_OPT_END
285 };
286 struct fuse_args args = FUSE_ARGS_INIT(argc, argv);
ee675fe @hzeller o Provide a way to select between different filter diretories.
authored
287 fuse_opt_parse(&args, &folve_rt, folve_options, FolveOptionHandling);
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
288
fa525ee @hzeller o If we find problems in the options, complain and exit.
authored
289 if (folve_rt.parameter_error || !folve_rt.fs->CheckInitialized()) {
1e9ff21 @hzeller o main: report if parameters are not directories.
authored
290 return usage(progname);
291 }
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
292
293 struct fuse_operations folve_operations;
294 memset(&folve_operations, 0, sizeof(folve_operations));
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
295
0a3400d @hzeller o Write when we're exiting.
authored
296 // Start/stop. Will write to syslog and start auxiliary http service.
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
297 folve_operations.init = folve_init;
0a3400d @hzeller o Write when we're exiting.
authored
298 folve_operations.destroy = folve_destroy;
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
299
300 // Basic operations to make navigation work.
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
301 folve_operations.readdir = folve_readdir;
302 folve_operations.readlink = folve_readlink;
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
303
304 // open() and close() file.
38cdeb1 @hzeller o whitespace changes.
authored
305 folve_operations.open = folve_open;
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
306 folve_operations.release = folve_release;
8d1fbe7 @hzeller o Move fuse-convolve.c to fuse-convolve.cc. Make filter-interface
authored
307
308 // Actual workhorse: reading a file and returning predicted file-size
0330f76 @hzeller o Only start status server after we're daemonized, otherwise
authored
309 folve_operations.read = folve_read;
310 folve_operations.fgetattr = folve_fgetattr;
311 folve_operations.getattr = folve_getattr;
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
312
27c44cd @hzeller o Use fuse option handling to extract our flags and options.
authored
313 return fuse_main(args.argc, args.argv, &folve_operations, NULL);
98a5725 @hzeller o Start implementation. Just a basic forwarding filesystem for
authored
314 }
Something went wrong with that request. Please try again.