1
2
3
4
5
6
7 #ifndef MC__VFS_VFS_H
8 #define MC__VFS_VFS_H
9
10 #include <sys/types.h>
11 #include <sys/stat.h>
12 #include <dirent.h>
13 #ifdef HAVE_UTIMENSAT
14 #include <sys/time.h>
15 #elif defined (HAVE_UTIME_H)
16 #include <utime.h>
17 #endif
18 #include <stdio.h>
19 #include <unistd.h>
20 #include <stddef.h>
21
22 #include "lib/global.h"
23
24 #include "path.h"
25
26
27
28 #define VFS_CLASS(a) ((struct vfs_class *) (a))
29
30 #define VFS_ENCODING_PREFIX "#enc:"
31
32 #define O_ALL (O_CREAT | O_EXCL | O_NOCTTY | O_NDELAY | O_SYNC | O_WRONLY | O_RDWR | O_RDONLY)
33
34
35
36 #if (O_ALL & O_APPEND)
37 #warning "Unexpected problem with flags, O_LINEAR disabled, contact pavel@ucw.cz"
38 #define O_LINEAR 0
39 #define IS_LINEAR(a) 0
40 #define NO_LINEAR(a) a
41 #else
42 #define O_LINEAR O_APPEND
43 #define IS_LINEAR(a) ((a) == (O_RDONLY | O_LINEAR))
44 #define NO_LINEAR(a) (((a) == (O_RDONLY | O_LINEAR)) ? O_RDONLY : (a))
45 #endif
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64 #ifdef ENOMSG
65 #define E_UNKNOWN ENOMSG
66 #else
67 #define E_UNKNOWN EIO
68 #endif
69
70 #ifdef EREMOTEIO
71 #define E_REMOTE EREMOTEIO
72 #else
73 #define E_REMOTE ENETUNREACH
74 #endif
75
76 #ifdef EPROTO
77 #define E_PROTO EPROTO
78 #else
79 #define E_PROTO EIO
80 #endif
81
82
83
84
85
86
87
88 typedef void (*fill_names_f) (const char *);
89
90 typedef void *vfsid;
91
92 #ifdef HAVE_UTIMENSAT
93 typedef struct timespec mc_timesbuf_t[2];
94 #else
95 typedef struct utimbuf mc_timesbuf_t;
96 #endif
97
98
99
100 typedef enum
101 {
102 VFSF_UNKNOWN = 0,
103 VFSF_LOCAL = 1 << 0,
104 VFSF_NOLINKS = 1 << 1,
105
106 VFSF_REMOTE = 1 << 2,
107 VFSF_READONLY = 1 << 3,
108 VFSF_USETMP = 1 << 4
109 } vfs_flags_t;
110
111
112 enum
113 {
114 VFS_CTL_IS_NOTREADY
115 };
116
117
118 enum
119 {
120 VFS_SETCTL_FORGET,
121 VFS_SETCTL_RUN,
122 VFS_SETCTL_LOGFILE,
123 VFS_SETCTL_FLUSH,
124
125
126
127 VFS_SETCTL_STALE_DATA
128 };
129
130
131
132 typedef struct vfs_class
133 {
134 const char *name;
135 vfs_flags_t flags;
136 const char *prefix;
137 int verrno;
138 gboolean flush;
139 FILE *logfile;
140
141
142 int (*init) (struct vfs_class * me);
143 void (*done) (struct vfs_class * me);
144
145
146
147
148
149 void (*fill_names) (struct vfs_class * me, fill_names_f);
150
151
152
153
154
155 int (*which) (struct vfs_class * me, const char *path);
156
157 void *(*open) (const vfs_path_t * vpath, int flags, mode_t mode);
158 int (*close) (void *vfs_info);
159 ssize_t (*read) (void *vfs_info, char *buffer, size_t count);
160 ssize_t (*write) (void *vfs_info, const char *buf, size_t count);
161
162 void *(*opendir) (const vfs_path_t * vpath);
163 struct vfs_dirent *(*readdir) (void *vfs_info);
164 int (*closedir) (void *vfs_info);
165
166 int (*stat) (const vfs_path_t * vpath, struct stat * buf);
167 int (*lstat) (const vfs_path_t * vpath, struct stat * buf);
168 int (*fstat) (void *vfs_info, struct stat * buf);
169
170 int (*chmod) (const vfs_path_t * vpath, mode_t mode);
171 int (*chown) (const vfs_path_t * vpath, uid_t owner, gid_t group);
172
173 int (*fgetflags) (const vfs_path_t * vpath, unsigned long *flags);
174 int (*fsetflags) (const vfs_path_t * vpath, unsigned long flags);
175
176 int (*utime) (const vfs_path_t * vpath, mc_timesbuf_t * times);
177
178 int (*readlink) (const vfs_path_t * vpath, char *buf, size_t size);
179 int (*symlink) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
180 int (*link) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
181 int (*unlink) (const vfs_path_t * vpath);
182 int (*rename) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
183 int (*chdir) (const vfs_path_t * vpath);
184 int (*ferrno) (struct vfs_class * me);
185 off_t (*lseek) (void *vfs_info, off_t offset, int whence);
186 int (*mknod) (const vfs_path_t * vpath, mode_t mode, dev_t dev);
187
188 vfsid (*getid) (const vfs_path_t * vpath);
189
190 gboolean (*nothingisopen) (vfsid id);
191 void (*free) (vfsid id);
192
193 vfs_path_t *(*getlocalcopy) (const vfs_path_t * vpath);
194 int (*ungetlocalcopy) (const vfs_path_t * vpath, const vfs_path_t * local_vpath,
195 gboolean has_changed);
196
197 int (*mkdir) (const vfs_path_t * vpath, mode_t mode);
198 int (*rmdir) (const vfs_path_t * vpath);
199
200 int (*ctl) (void *vfs_info, int ctlop, void *arg);
201 int (*setctl) (const vfs_path_t * vpath, int ctlop, void *arg);
202
203 } vfs_class;
204
205
206
207
208
209 struct vfs_dirent
210 {
211
212 GString *d_name_str;
213
214
215 ino_t d_ino;
216 char *d_name;
217 };
218
219
220
221 extern int vfs_timeout;
222
223 #ifdef ENABLE_VFS_NET
224 extern int use_netrc;
225 #endif
226
227
228
229
230 void vfs_init_class (struct vfs_class *vclass, const char *name, vfs_flags_t flags,
231 const char *prefix);
232
233 void *vfs_s_open (const vfs_path_t * vpath, int flags, mode_t mode);
234 int vfs_s_stat (const vfs_path_t * vpath, struct stat *buf);
235 int vfs_s_lstat (const vfs_path_t * vpath, struct stat *buf);
236 int vfs_s_fstat (void *fh, struct stat *buf);
237
238 void vfs_adjust_stat (struct stat *s);
239
240 vfsid vfs_getid (const vfs_path_t * vpath);
241
242 void vfs_init (void);
243 void vfs_shut (void);
244
245 gboolean vfs_register_class (struct vfs_class *vfs);
246 void vfs_unregister_class (struct vfs_class *vfs);
247
248 void vfs_setup_work_dir (void);
249
250 void vfs_timeout_handler (void);
251 int vfs_timeouts (void);
252 void vfs_expire (gboolean now);
253
254 const char *vfs_get_current_dir (void);
255 char *vfs_get_current_dir_n (void);
256 const vfs_path_t *vfs_get_raw_current_dir (void);
257 void vfs_set_raw_current_dir (const vfs_path_t * vpath);
258
259 gboolean vfs_current_is_local (void);
260 gboolean vfs_file_is_local (const vfs_path_t * vpath);
261
262 char *vfs_strip_suffix_from_filename (const char *filename);
263
264 vfs_flags_t vfs_file_class_flags (const vfs_path_t * vpath);
265
266
267
268
269 const char *vfs_translate_path (const char *path);
270
271 char *vfs_translate_path_n (const char *path);
272
273 void vfs_stamp_path (const vfs_path_t * path);
274
275 void vfs_release_path (const vfs_path_t * vpath);
276
277 struct vfs_dirent *vfs_dirent_init (struct vfs_dirent *d, const char *fname, ino_t ino);
278 void vfs_dirent_assign (struct vfs_dirent *d, const char *fname, ino_t ino);
279 void vfs_dirent_free (struct vfs_dirent *d);
280
281 void vfs_fill_names (fill_names_f);
282
283
284 void vfs_print_message (const char *msg, ...) G_GNUC_PRINTF (1, 2);
285
286
287 int vfs_ferrno (struct vfs_class *vfs);
288
289 int vfs_new_handle (struct vfs_class *vclass, void *fsinfo);
290
291 struct vfs_class *vfs_class_find_by_handle (int handle, void **fsinfo);
292
293 void vfs_free_handle (int handle);
294
295 void vfs_setup_cwd (void);
296 char *vfs_get_cwd (void);
297
298 int vfs_preallocate (int dest_desc, off_t src_fsize, off_t dest_fsize);
299
300 int vfs_clone_file (int dest_vfs_fd, int src_vfs_fd);
301
302
303
304
305 ssize_t mc_read (int handle, void *buffer, size_t count);
306 ssize_t mc_write (int handle, const void *buffer, size_t count);
307 int mc_utime (const vfs_path_t * vpath, mc_timesbuf_t * times);
308 int mc_readlink (const vfs_path_t * vpath, char *buf, size_t bufsiz);
309 int mc_close (int handle);
310 off_t mc_lseek (int fd, off_t offset, int whence);
311 DIR *mc_opendir (const vfs_path_t * vpath);
312 struct vfs_dirent *mc_readdir (DIR * dirp);
313 int mc_closedir (DIR * dir);
314 int mc_stat (const vfs_path_t * vpath, struct stat *buf);
315 int mc_mknod (const vfs_path_t * vpath, mode_t mode, dev_t dev);
316 int mc_link (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
317 int mc_mkdir (const vfs_path_t * vpath, mode_t mode);
318 int mc_rmdir (const vfs_path_t * vpath);
319 int mc_fstat (int fd, struct stat *buf);
320 int mc_lstat (const vfs_path_t * vpath, struct stat *buf);
321 int mc_symlink (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
322 int mc_rename (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
323 int mc_chmod (const vfs_path_t * vpath, mode_t mode);
324 int mc_chown (const vfs_path_t * vpath, uid_t owner, gid_t group);
325 int mc_fgetflags (const vfs_path_t * vpath, unsigned long *flags);
326 int mc_fsetflags (const vfs_path_t * vpath, unsigned long flags);
327 int mc_chdir (const vfs_path_t * vpath);
328 int mc_unlink (const vfs_path_t * vpath);
329 int mc_ctl (int fd, int ctlop, void *arg);
330 int mc_setctl (const vfs_path_t * vpath, int ctlop, void *arg);
331 int mc_open (const vfs_path_t * vpath, int flags, ...);
332 vfs_path_t *mc_getlocalcopy (const vfs_path_t * pathname_vpath);
333 int mc_ungetlocalcopy (const vfs_path_t * pathname_vpath, const vfs_path_t * local_vpath,
334 gboolean has_changed);
335 int mc_mkstemps (vfs_path_t ** pname_vpath, const char *prefix, const char *suffix);
336
337
338 const char *mc_tmpdir (void);
339
340
341
342
343 #endif