lib/vfs/vfs.h

   1
   2 /**
   3  * \file
   4  * \brief Header: Virtual File System switch code
   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_UTIME_H
  14 #include <utime.h>
  15 #endif
  16 #include <stdio.h>
  17 #include <unistd.h>
  18 #include <stddef.h>
  19
  20 #include "lib/global.h"
  21 #include "lib/fs.h"             /* MC_MAXPATHLEN */
  22
  23 #include "path.h"
  24
  25 /*** typedefs(not structures) and defined constants **********************************************/
  26
  27 #if defined (ENABLE_VFS_FTP) || defined (ENABLE_VFS_FISH) || defined (ENABLE_VFS_SMB)
  28 #define ENABLE_VFS_NET 1
  29 #endif
  30
  31 /**
  32  * This is the type of callback function passed to vfs_fill_names.
  33  * It gets the name of the virtual file system as its first argument.
  34  * See also:
  35  *    vfs_fill_names().
  36  */
  37
  38 #define VFS_ENCODING_PREFIX "#enc:"
  39
  40 #define O_ALL (O_CREAT | O_EXCL | O_NOCTTY | O_NDELAY | O_SYNC | O_WRONLY | O_RDWR | O_RDONLY)
  41 /* Midnight commander code should _not_ use other flags than those
  42    listed above and O_APPEND */
  43
  44 #if (O_ALL & O_APPEND)
  45 #warning "Unexpected problem with flags, O_LINEAR disabled, contact pavel@ucw.cz"
  46 #define O_LINEAR 0
  47 #define IS_LINEAR(a) 0
  48 #define NO_LINEAR(a) a
  49 #else
  50 #define O_LINEAR O_APPEND
  51 #define IS_LINEAR(a) ((a) == (O_RDONLY | O_LINEAR))     /* Return only 0 and 1 ! */
  52 #define NO_LINEAR(a) (((a) == (O_RDONLY | O_LINEAR)) ? O_RDONLY : (a))
  53 #endif
  54
  55 /* O_LINEAR is strange beast, be careful. If you open file asserting
  56  * O_RDONLY | O_LINEAR, you promise:
  57  *
  58  *      a) to read file linearly from beginning to the end
  59  *      b) not to open another file before you close this one
  60  *              (this will likely go away in future)
  61  *      as a special gift, you may
  62  *      c) lseek() immediately after open(), giving ftpfs chance to
  63  *         reget. Be warned that this lseek() can fail, and you _have_
  64  *         to handle that gratefully.
  65  *
  66  * O_LINEAR allows filesystems not to create temporary file in some
  67  * cases (ftp transfer).                                -- pavel@ucw.cz
  68  */
  69
  70 /* And now some defines for our errors. */
  71
  72 #ifdef ENOSYS
  73 #define E_NOTSUPP ENOSYS        /* for use in vfs when module does not provide function */
  74 #else
  75 #define E_NOTSUPP EFAULT        /* Does this happen? */
  76 #endif
  77
  78 #ifdef ENOMSG
  79 #define E_UNKNOWN ENOMSG        /* if we do not know what error happened */
  80 #else
  81 #define E_UNKNOWN EIO           /* if we do not know what error happened */
  82 #endif
  83
  84 #ifdef EREMOTEIO
  85 #define E_REMOTE EREMOTEIO      /* if other side of ftp/fish reports error */
  86 #else
  87 #define E_REMOTE ENETUNREACH    /* :-( there's no EREMOTEIO on some systems */
  88 #endif
  89
  90 #ifdef EPROTO
  91 #define E_PROTO EPROTO          /* if other side fails to follow protocol */
  92 #else
  93 #define E_PROTO EIO
  94 #endif
  95
  96 typedef void (*fill_names_f) (const char *);
  97
  98 typedef void *vfsid;
  99
 100 /*** enums ***************************************************************************************/
 101
 102 /* Flags of VFS classes */
 103 typedef enum
 104 {
 105     VFSF_UNKNOWN = 0,
 106     VFSF_LOCAL = 1 << 0,        /* Class is local (not virtual) filesystem */
 107     VFSF_NOLINKS = 1 << 1       /* Hard links not supported */
 108 } vfs_class_flags_t;
 109
 110 /* Operations for mc_ctl - on open file */
 111 enum
 112 {
 113     VFS_CTL_IS_NOTREADY
 114 };
 115
 116 /* Operations for mc_setctl - on path */
 117 enum
 118 {
 119     VFS_SETCTL_FORGET,
 120     VFS_SETCTL_RUN,
 121     VFS_SETCTL_LOGFILE,
 122     VFS_SETCTL_FLUSH,           /* invalidate directory cache */
 123
 124     /* Setting this makes vfs layer give out potentially incorrect data,
 125        but it also makes some operations much faster. Use with caution. */
 126     VFS_SETCTL_STALE_DATA
 127 };
 128
 129 /*** structures declarations (and typedefs of structures)*****************************************/
 130
 131 typedef struct vfs_class
 132 {
 133     const char *name;           /* "FIles over SHell" */
 134     vfs_class_flags_t flags;
 135     const char *prefix;         /* "fish:" */
 136     void *data;                 /* this is for filesystem's own use */
 137     int verrno;                 /* can't use errno because glibc2 might define errno as function */
 138
 139     /* *INDENT-OFF* */
 140     int (*init) (struct vfs_class * me);
 141     void (*done) (struct vfs_class * me);
 142
 143     /**
 144      * The fill_names method shall call the callback function for every
 145      * filesystem name that this vfs module supports.
 146      */
 147     void (*fill_names) (struct vfs_class * me, fill_names_f);
 148
 149     /**
 150      * The which() method shall return the index of the vfs subsystem
 151      * or -1 if this vfs cannot handle the given pathname.
 152      */
 153     int (*which) (struct vfs_class * me, const char *path);
 154
 155     void *(*open) (const vfs_path_t * vpath, int flags, mode_t mode);
 156     int (*close) (void *vfs_info);
 157     ssize_t (*read) (void *vfs_info, char *buffer, size_t count);
 158     ssize_t (*write) (void *vfs_info, const char *buf, size_t count);
 159
 160     void *(*opendir) (const vfs_path_t * vpath);
 161     void *(*readdir) (void *vfs_info);
 162     int (*closedir) (void *vfs_info);
 163
 164     int (*stat) (const vfs_path_t * vpath, struct stat * buf);
 165     int (*lstat) (const vfs_path_t * vpath, struct stat * buf);
 166     int (*fstat) (void *vfs_info, struct stat * buf);
 167
 168     int (*chmod) (const vfs_path_t * vpath, mode_t mode);
 169     int (*chown) (const vfs_path_t * vpath, uid_t owner, gid_t group);
 170     int (*utime) (const vfs_path_t * vpath, struct utimbuf * times);
 171
 172     int (*readlink) (const vfs_path_t * vpath, char *buf, size_t size);
 173     int (*symlink) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 174     int (*link) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 175     int (*unlink) (const vfs_path_t * vpath);
 176     int (*rename) (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 177     int (*chdir) (const vfs_path_t * vpath);
 178     int (*ferrno) (struct vfs_class * me);
 179     off_t (*lseek) (void *vfs_info, off_t offset, int whence);
 180     int (*mknod) (const vfs_path_t * vpath, mode_t mode, dev_t dev);
 181
 182     vfsid (*getid) (const vfs_path_t * vpath);
 183
 184     int (*nothingisopen) (vfsid id);
 185     void (*free) (vfsid id);
 186
 187     vfs_path_t *(*getlocalcopy) (const vfs_path_t * vpath);
 188     int (*ungetlocalcopy) (const vfs_path_t * vpath, const vfs_path_t * local_vpath,
 189                            gboolean has_changed);
 190
 191     int (*mkdir) (const vfs_path_t * vpath, mode_t mode);
 192     int (*rmdir) (const vfs_path_t * vpath);
 193
 194     int (*ctl) (void *vfs_info, int ctlop, void *arg);
 195     int (*setctl) (const vfs_path_t * vpath, int ctlop, void *arg);
 196     /* *INDENT-ON* */
 197 } vfs_class;
 198
 199 /*
 200  * This union is used to ensure that there is enough space for the
 201  * filename (d_name) when the dirent structure is created.
 202  */
 203 union vfs_dirent
 204 {
 205     struct dirent dent;
 206     char _extra_buffer[offsetof (struct dirent, d_name) + MC_MAXPATHLEN + 1];
 207 };
 208
 209 /*** global variables defined in .c file *********************************************************/
 210
 211 extern int vfs_timeout;
 212
 213 #ifdef ENABLE_VFS_NET
 214 extern int use_netrc;
 215 #endif
 216
 217 /*** declarations of public functions ************************************************************/
 218
 219 /* lib/vfs/direntry.c: */
 220 void *vfs_s_open (const vfs_path_t * vpath, int flags, mode_t mode);
 221
 222 vfsid vfs_getid (const vfs_path_t * vpath);
 223
 224 void vfs_init (void);
 225 void vfs_shut (void);
 226 /* Register a file system class */
 227 gboolean vfs_register_class (struct vfs_class *vfs);
 228
 229 void vfs_setup_work_dir (void);
 230
 231 void vfs_timeout_handler (void);
 232 int vfs_timeouts (void);
 233 void vfs_expire (gboolean now);
 234
 235 const char *vfs_get_current_dir (void);
 236 char *vfs_get_current_dir_n (void);
 237 const vfs_path_t *vfs_get_raw_current_dir (void);
 238 void vfs_set_raw_current_dir (const vfs_path_t * vpath);
 239
 240 gboolean vfs_current_is_local (void);
 241 gboolean vfs_file_is_local (const vfs_path_t * vpath);
 242
 243 char *vfs_strip_suffix_from_filename (const char *filename);
 244
 245 vfs_class_flags_t vfs_file_class_flags (const vfs_path_t * vpath);
 246
 247 /* translate path back to terminal encoding, remove all #enc:
 248  * every invalid character is replaced with question mark
 249  * return static buffer */
 250 const char *vfs_translate_path (const char *path);
 251 /* return new string */
 252 char *vfs_translate_path_n (const char *path);
 253
 254 void vfs_stamp_path (const char *path);
 255
 256 void vfs_release_path (const vfs_path_t * vpath);
 257
 258 void vfs_fill_names (fill_names_f);
 259
 260 /* *INDENT-OFF* */
 261 void vfs_print_message (const char *msg, ...) G_GNUC_PRINTF (1, 2);
 262 /* *INDENT-ON* */
 263
 264 int vfs_ferrno (struct vfs_class *vfs);
 265
 266 int vfs_new_handle (struct vfs_class *vclass, void *fsinfo);
 267
 268 struct vfs_class *vfs_class_find_by_handle (int handle);
 269
 270 void *vfs_class_data_find_by_handle (int handle);
 271
 272 void vfs_free_handle (int handle);
 273
 274 void vfs_setup_cwd (void);
 275 char *_vfs_get_cwd (void);
 276
 277 int vfs_preallocate (int dest_desc, off_t src_fsize, off_t dest_fsize);
 278
 279 /**
 280  * Interface functions described in interface.c
 281  */
 282 ssize_t mc_read (int handle, void *buffer, size_t count);
 283 ssize_t mc_write (int handle, const void *buffer, size_t count);
 284 int mc_utime (const vfs_path_t * vpath, struct utimbuf *times);
 285 int mc_readlink (const vfs_path_t * vpath, char *buf, size_t bufsiz);
 286 int mc_close (int handle);
 287 off_t mc_lseek (int fd, off_t offset, int whence);
 288 DIR *mc_opendir (const vfs_path_t * vpath);
 289 struct dirent *mc_readdir (DIR * dirp);
 290 int mc_closedir (DIR * dir);
 291 int mc_stat (const vfs_path_t * vpath, struct stat *buf);
 292 int mc_mknod (const vfs_path_t * vpath, mode_t mode, dev_t dev);
 293 int mc_link (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 294 int mc_mkdir (const vfs_path_t * vpath, mode_t mode);
 295 int mc_rmdir (const vfs_path_t * vpath);
 296 int mc_fstat (int fd, struct stat *buf);
 297 int mc_lstat (const vfs_path_t * vpath, struct stat *buf);
 298 int mc_symlink (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 299 int mc_rename (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 300 int mc_chmod (const vfs_path_t * vpath, mode_t mode);
 301 int mc_chown (const vfs_path_t * vpath, uid_t owner, gid_t group);
 302 int mc_chdir (const vfs_path_t * vpath);
 303 int mc_unlink (const vfs_path_t * vpath);
 304 int mc_ctl (int fd, int ctlop, void *arg);
 305 int mc_setctl (const vfs_path_t * vpath, int ctlop, void *arg);
 306 int mc_open (const vfs_path_t * vpath, int flags, ...);
 307 vfs_path_t *mc_getlocalcopy (const vfs_path_t * pathname_vpath);
 308 int mc_ungetlocalcopy (const vfs_path_t * pathname_vpath, const vfs_path_t * local_vpath,
 309                        gboolean has_changed);
 310 int mc_mkstemps (vfs_path_t ** pname_vpath, const char *prefix, const char *suffix);
 311
 312 /* Creating temporary files safely */
 313 const char *mc_tmpdir (void);
 314
 315
 316 /*** inline functions ****************************************************************************/
 317
 318 #endif /* MC_VFS_VFS_H */