4 * \brief Header: Virtual File System switch code
10 #include <sys/types.h>
12 #include <dirent.h> /* DIR */
15 #elif defined (HAVE_UTIME_H)
22 #include "lib/global.h"
26 /*** typedefs(not structures) and defined constants **********************************************/
28 #define VFS_CLASS(a) ((struct vfs_class *) (a))
30 #define VFS_ENCODING_PREFIX "#enc:"
32 #define O_ALL (O_CREAT | O_EXCL | O_NOCTTY | O_NDELAY | O_SYNC | O_WRONLY | O_RDWR | O_RDONLY)
33 /* Midnight commander code should _not_ use other flags than those
34 listed above and O_APPEND */
36 #if (O_ALL & O_APPEND)
37 #warning "Unexpected problem with flags, O_LINEAR disabled, contact pavel@ucw.cz"
39 #define IS_LINEAR(a) 0
40 #define NO_LINEAR(a) a
42 #define O_LINEAR O_APPEND
43 #define IS_LINEAR(a) ((a) == (O_RDONLY | O_LINEAR)) /* Return only 0 and 1 ! */
44 #define NO_LINEAR(a) (((a) == (O_RDONLY | O_LINEAR)) ? O_RDONLY : (a))
47 /* O_LINEAR is strange beast, be careful. If you open file asserting
48 * O_RDONLY | O_LINEAR, you promise:
50 * a) to read file linearly from beginning to the end
51 * b) not to open another file before you close this one
52 * (this will likely go away in future)
53 * as a special gift, you may
54 * c) lseek() immediately after open(), giving ftpfs chance to
55 * reget. Be warned that this lseek() can fail, and you _have_
56 * to handle that gratefully.
58 * O_LINEAR allows filesystems not to create temporary file in some
59 * cases (ftp transfer). -- pavel@ucw.cz
62 /* And now some defines for our errors. */
65 #define E_UNKNOWN ENOMSG /* if we do not know what error happened */
67 #define E_UNKNOWN EIO /* if we do not know what error happened */
71 #define E_REMOTE EREMOTEIO /* if other side of ftp/shell reports error */
73 #define E_REMOTE ENETUNREACH /* :-( there's no EREMOTEIO on some systems */
77 #define E_PROTO EPROTO /* if other side fails to follow protocol */
83 * This is the type of callback function passed to vfs_fill_names.
84 * It gets the name of the virtual file system as its first argument.
88 typedef void (*fill_names_f
) (const char *);
93 typedef struct timespec mc_timesbuf_t
[2];
95 typedef struct utimbuf mc_timesbuf_t
;
98 /*** enums ***************************************************************************************/
103 VFSF_LOCAL
= 1 << 0, /* Class is local (not virtual) filesystem */
104 VFSF_NOLINKS
= 1 << 1, /* Hard links not supported */
106 VFSF_REMOTE
= 1 << 2,
107 VFSF_READONLY
= 1 << 3,
111 /* Operations for mc_ctl - on open file */
117 /* Operations for mc_setctl - on path */
123 VFS_SETCTL_FLUSH
, /* invalidate directory cache */
125 /* Setting this makes vfs layer give out potentially incorrect data,
126 but it also makes some operations much faster. Use with caution. */
127 VFS_SETCTL_STALE_DATA
130 /*** structures declarations (and typedefs of structures)*****************************************/
132 typedef struct vfs_class
134 const char *name
; /* "FIles over SHell" */
136 const char *prefix
; /* "shell:" */
137 int verrno
; /* can't use errno because glibc2 might define errno as function */
138 gboolean flush
; /* if set to TRUE, invalidate directory cache */
142 int (*init
) (struct vfs_class
* me
);
143 void (*done
) (struct vfs_class
* me
);
146 * The fill_names method shall call the callback function for every
147 * filesystem name that this vfs module supports.
149 void (*fill_names
) (struct vfs_class
* me
, fill_names_f
);
152 * The which() method shall return the index of the vfs subsystem
153 * or -1 if this vfs cannot handle the given pathname.
155 int (*which
) (struct vfs_class
* me
, const char *path
);
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
);
162 void *(*opendir
) (const vfs_path_t
* vpath
);
163 struct vfs_dirent
*(*readdir
) (void *vfs_info
);
164 int (*closedir
) (void *vfs_info
);
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
);
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
);
173 int (*fgetflags
) (const vfs_path_t
* vpath
, unsigned long *flags
);
174 int (*fsetflags
) (const vfs_path_t
* vpath
, unsigned long flags
);
176 int (*utime
) (const vfs_path_t
* vpath
, mc_timesbuf_t
* times
);
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
);
188 vfsid (*getid
) (const vfs_path_t
* vpath
);
190 gboolean (*nothingisopen
) (vfsid id
);
191 void (*free
) (vfsid id
);
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
);
197 int (*mkdir
) (const vfs_path_t
* vpath
, mode_t mode
);
198 int (*rmdir
) (const vfs_path_t
* vpath
);
200 int (*ctl
) (void *vfs_info
, int ctlop
, void *arg
);
201 int (*setctl
) (const vfs_path_t
* vpath
, int ctlop
, void *arg
);
206 * This struct is used instead of standard dirent to hold file name of any length
207 * (not limited to NAME_MAX).
216 char *d_name
; /* Alias of d_name_str->str */
219 /*** global variables defined in .c file *********************************************************/
221 extern int vfs_timeout
;
223 #ifdef ENABLE_VFS_NET
224 extern int use_netrc
;
227 /*** declarations of public functions ************************************************************/
229 /* lib/vfs/direntry.c: */
230 void vfs_init_class (struct vfs_class
*vclass
, const char *name
, vfs_flags_t flags
,
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
);
238 void vfs_adjust_stat (struct stat
*s
);
240 vfsid
vfs_getid (const vfs_path_t
* vpath
);
242 void vfs_init (void);
243 void vfs_shut (void);
244 /* Register a file system class */
245 gboolean
vfs_register_class (struct vfs_class
*vfs
);
246 void vfs_unregister_class (struct vfs_class
*vfs
);
248 void vfs_setup_work_dir (void);
250 void vfs_timeout_handler (void);
251 int vfs_timeouts (void);
252 void vfs_expire (gboolean now
);
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
);
259 gboolean
vfs_current_is_local (void);
260 gboolean
vfs_file_is_local (const vfs_path_t
* vpath
);
262 char *vfs_strip_suffix_from_filename (const char *filename
);
264 vfs_flags_t
vfs_file_class_flags (const vfs_path_t
* vpath
);
266 /* translate path back to terminal encoding, remove all #enc:
267 * every invalid character is replaced with question mark
268 * return static buffer */
269 const char *vfs_translate_path (const char *path
);
270 /* return new string */
271 char *vfs_translate_path_n (const char *path
);
273 void vfs_stamp_path (const vfs_path_t
* path
);
275 void vfs_release_path (const vfs_path_t
* vpath
);
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
);
281 void vfs_fill_names (fill_names_f
);
284 void vfs_print_message (const char *msg
, ...) G_GNUC_PRINTF (1, 2);
287 int vfs_ferrno (struct vfs_class
*vfs
);
289 int vfs_new_handle (struct vfs_class
*vclass
, void *fsinfo
);
291 struct vfs_class
*vfs_class_find_by_handle (int handle
, void **fsinfo
);
293 void vfs_free_handle (int handle
);
295 void vfs_setup_cwd (void);
296 char *vfs_get_cwd (void);
298 int vfs_preallocate (int dest_desc
, off_t src_fsize
, off_t dest_fsize
);
300 int vfs_clone_file (int dest_vfs_fd
, int src_vfs_fd
);
303 * Interface functions described in interface.c
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
);
337 /* Creating temporary files safely */
338 const char *mc_tmpdir (void);
341 /*** inline functions ****************************************************************************/
343 #endif /* MC_VFS_VFS_H */