2 Virtual File System: interface functions
5 The Free Software Foundation, Inc.
8 Slava Zanko <slavazanko@gmail.com>, 2011
10 This file is part of the Midnight Commander.
12 The Midnight Commander is free software: you can redistribute it
13 and/or modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation, either version 3 of the License,
15 or (at your option) any later version.
17 The Midnight Commander is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 * \brief Source: Virtual File System: path handlers
37 #include <stdlib.h> /* For atol() */
41 #include <sys/types.h>
43 #include <ctype.h> /* is_digit() */
49 #include "lib/global.h"
51 #include "lib/widget.h" /* message() */
52 #include "lib/strutil.h" /* str_crt_conv_from() */
59 extern GString
*vfs_str_buffer
;
60 extern struct vfs_class
*current_vfs
;
62 /*** global variables ****************************************************************************/
64 struct dirent
*mc_readdir_result
= NULL
;
66 /*** file scope macro definitions ****************************************************************/
68 /*** file scope type declarations ****************************************************************/
70 /*** file scope variables ************************************************************************/
72 /*** file scope functions ************************************************************************/
73 /* --------------------------------------------------------------------------------------------- */
76 mc_def_getlocalcopy (const char *filename
)
79 int fdin
= -1, fdout
= -1;
81 char buffer
[BUF_1K
* 8];
85 vpath
= vfs_path_from_str (filename
);
86 fdin
= mc_open (vpath
, O_RDONLY
| O_LINEAR
);
90 fdout
= vfs_mkstemps (&tmp
, "vfs", filename
);
94 while ((i
= mc_read (fdin
, buffer
, sizeof (buffer
))) > 0)
96 if (write (fdout
, buffer
, i
) != i
)
105 if (close (fdout
) == -1)
111 if (mc_stat (vpath
, &mystat
) != -1)
112 chmod (tmp
, mystat
.st_mode
);
113 vfs_path_free (vpath
);
118 vfs_path_free (vpath
);
127 /* --------------------------------------------------------------------------------------------- */
130 mc_def_ungetlocalcopy (struct vfs_class
*vfs
, const char *filename
,
131 const char *local
, int has_changed
)
134 int fdin
= -1, fdout
= -1;
136 vpath
= vfs_path_from_str (filename
);
140 char buffer
[BUF_1K
* 8];
146 fdin
= open (local
, O_RDONLY
);
149 fdout
= mc_open (vpath
, O_WRONLY
| O_TRUNC
);
152 while ((i
= read (fdin
, buffer
, sizeof (buffer
))) > 0)
153 if (mc_write (fdout
, buffer
, (size_t) i
) != i
)
158 if (close (fdin
) == -1)
164 if (mc_close (fdout
) == -1)
171 vfs_path_free (vpath
);
175 message (D_ERROR
, _("Changes to file lost"), "%s", filename
);
181 vfs_path_free (vpath
);
185 /* --------------------------------------------------------------------------------------------- */
186 /*** public functions ****************************************************************************/
187 /* --------------------------------------------------------------------------------------------- */
190 mc_open (const vfs_path_t
* vpath
, int flags
, ...)
192 int mode
= 0, result
= -1;
193 vfs_path_element_t
*path_element
;
198 /* Get the mode flag */
202 va_start (ap
, flags
);
203 mode
= va_arg (ap
, int);
207 path_element
= vfs_path_get_by_index (vpath
, -1);
208 if (vfs_path_element_valid (path_element
) && path_element
->class->open
!= NULL
)
211 /* open must be supported */
212 info
= path_element
->class->open (vpath
, flags
, mode
);
214 errno
= vfs_ferrno (path_element
->class);
216 result
= vfs_new_handle (path_element
->class, info
);
224 /* --------------------------------------------------------------------------------------------- */
228 #define MC_NAMEOP(name, inarg, callarg) \
229 int mc_##name inarg \
232 vfs_path_element_t *path_element; \
237 path_element = vfs_path_get_by_index (vpath, -1); \
238 if (!vfs_path_element_valid (path_element)) \
243 result = path_element->class->name != NULL ? path_element->class->name callarg : -1; \
245 errno = path_element->class->name != NULL ? vfs_ferrno (path_element->class) : E_NOTSUPP; \
249 MC_NAMEOP (chmod
, (const vfs_path_t
*vpath
, mode_t mode
), (vpath
, mode
))
250 MC_NAMEOP (chown
, (const vfs_path_t
*vpath
, uid_t owner
, gid_t group
), (vpath
, owner
, group
))
251 MC_NAMEOP (utime
, (const vfs_path_t
*vpath
, struct utimbuf
* times
), (vpath
, times
))
252 MC_NAMEOP (readlink
, (const vfs_path_t
*vpath
, char *buf
, size_t bufsiz
), (vpath
, buf
, bufsiz
))
253 MC_NAMEOP (unlink
, (const vfs_path_t
*vpath
), (vpath
))
254 MC_NAMEOP (mkdir
, (const vfs_path_t
*vpath
, mode_t mode
), (vpath
, mode
))
255 MC_NAMEOP (rmdir
, (const vfs_path_t
*vpath
), (vpath
))
256 MC_NAMEOP (mknod
, (const vfs_path_t
*vpath
, mode_t mode
, dev_t dev
), (vpath
, mode
, dev
))
260 /* --------------------------------------------------------------------------------------------- */
263 mc_symlink (const vfs_path_t
* vpath1
, const vfs_path_t
* vpath2
)
272 vfs_path_element_t
*path_element
;
274 path_element
= vfs_path_get_by_index (vpath2
, -1);
275 if (vfs_path_element_valid (path_element
))
278 path_element
->class->symlink
!= NULL
?
279 path_element
->class->symlink (vpath1
, vpath2
) : -1;
283 path_element
->class->symlink
!= NULL
?
284 vfs_ferrno (path_element
->class) : E_NOTSUPP
;
290 /* --------------------------------------------------------------------------------------------- */
294 #define MC_HANDLEOP(name, inarg, callarg) \
295 ssize_t mc_##name inarg \
297 struct vfs_class *vfs; \
301 vfs = vfs_class_find_by_handle (handle); \
304 result = vfs->name != NULL ? vfs->name callarg : -1; \
306 errno = vfs->name != NULL ? vfs_ferrno (vfs) : E_NOTSUPP; \
310 MC_HANDLEOP (read
, (int handle
, void *buffer
, size_t count
), (vfs_class_data_find_by_handle (handle
), buffer
, count
))
311 MC_HANDLEOP (write
, (int handle
, const void *buf
, size_t nbyte
), (vfs_class_data_find_by_handle (handle
), buf
, nbyte
))
313 /* --------------------------------------------------------------------------------------------- */
315 #define MC_RENAMEOP(name) \
316 int mc_##name (const vfs_path_t *vpath1, const vfs_path_t *vpath2) \
319 vfs_path_element_t *path_element1, *path_element2; \
321 if (vpath1 == NULL || vpath2 == NULL) \
324 path_element1 = vfs_path_get_by_index (vpath1, - 1); \
325 path_element2 = vfs_path_get_by_index (vpath2, - 1); \
327 if (!vfs_path_element_valid (path_element1) || !vfs_path_element_valid (path_element2) || \
328 path_element1->class != path_element2->class) \
334 result = path_element1->class->name != NULL \
335 ? path_element1->class->name (vpath1, vpath2) \
338 errno = path_element1->class->name != NULL ? vfs_ferrno (path_element1->class) : E_NOTSUPP; \
347 /* --------------------------------------------------------------------------------------------- */
350 mc_ctl (int handle
, int ctlop
, void *arg
)
352 struct vfs_class
*vfs
= vfs_class_find_by_handle (handle
);
357 return vfs
->ctl
? (*vfs
->ctl
) (vfs_class_data_find_by_handle (handle
), ctlop
, arg
) : 0;
360 /* --------------------------------------------------------------------------------------------- */
363 mc_setctl (const vfs_path_t
* vpath
, int ctlop
, void *arg
)
367 vfs_path_element_t
*path_element
;
370 vfs_die ("You don't want to pass NULL to mc_setctl.");
372 path_element
= vfs_path_get_by_index (vpath
, -1);
373 if (vfs_path_element_valid (path_element
))
375 path_element
->class->setctl
!= NULL
? path_element
->class->setctl (vpath
,
381 /* --------------------------------------------------------------------------------------------- */
384 mc_close (int handle
)
386 struct vfs_class
*vfs
;
389 if (handle
== -1 || !vfs_class_data_find_by_handle (handle
))
392 vfs
= vfs_class_find_by_handle (handle
);
397 return close (handle
);
400 vfs_die ("VFS must support close.\n");
401 result
= (*vfs
->close
) (vfs_class_data_find_by_handle (handle
));
402 vfs_free_handle (handle
);
404 errno
= vfs_ferrno (vfs
);
409 /* --------------------------------------------------------------------------------------------- */
412 mc_opendir (const vfs_path_t
* vpath
)
414 int handle
, *handlep
;
416 vfs_path_element_t
*path_element
;
421 path_element
= vfs_path_get_by_index (vpath
, -1);
423 if (!vfs_path_element_valid (path_element
))
429 info
= path_element
->class->opendir
? (*path_element
->class->opendir
) (vpath
) : NULL
;
433 errno
= path_element
->class->opendir
? vfs_ferrno (path_element
->class) : E_NOTSUPP
;
437 path_element
->dir
.info
= info
;
439 path_element
->dir
.converter
=
440 (path_element
->encoding
!=
441 NULL
) ? str_crt_conv_from (path_element
->encoding
) : str_cnv_from_term
;
442 if (path_element
->dir
.converter
== INVALID_CONV
)
443 path_element
->dir
.converter
= str_cnv_from_term
;
445 handle
= vfs_new_handle (path_element
->class, vfs_path_element_clone (path_element
));
447 handlep
= g_new (int, 1);
449 return (DIR *) handlep
;
452 /* --------------------------------------------------------------------------------------------- */
455 mc_readdir (DIR * dirp
)
458 struct vfs_class
*vfs
;
459 struct dirent
*entry
= NULL
;
460 vfs_path_element_t
*vfs_path_element
;
463 if (!mc_readdir_result
)
465 /* We can't just allocate struct dirent as (see man dirent.h)
466 * struct dirent has VERY nonnaive semantics of allocating
467 * d_name in it. Moreover, linux's glibc-2.9 allocates dirents _less_,
468 * than 'sizeof (struct dirent)' making full bitwise (sizeof dirent) copy
469 * heap corrupter. So, allocate longliving dirent with at least
470 * (MAXNAMLEN + 1) for d_name in it.
471 * Strictly saying resulting dirent is unusable as we don't adjust internal
472 * structures, holding dirent size. But we don't use it in libc infrastructure.
473 * TODO: to make simpler homemade dirent-alike structure.
475 mc_readdir_result
= (struct dirent
*) g_malloc (sizeof (struct dirent
) + MAXNAMLEN
+ 1);
483 handle
= *(int *) dirp
;
485 vfs
= vfs_class_find_by_handle (handle
);
489 vfs_path_element
= vfs_class_data_find_by_handle (handle
);
492 entry
= (*vfs
->readdir
) (vfs_path_element
->dir
.info
);
495 g_string_set_size (vfs_str_buffer
, 0);
497 str_vfs_convert_from (vfs_path_element
->dir
.converter
, entry
->d_name
, vfs_str_buffer
);
498 mc_readdir_result
->d_ino
= entry
->d_ino
;
499 g_strlcpy (mc_readdir_result
->d_name
, vfs_str_buffer
->str
, MAXNAMLEN
+ 1);
502 errno
= vfs
->readdir
? vfs_ferrno (vfs
) : E_NOTSUPP
;
503 return (entry
!= NULL
) ? mc_readdir_result
: NULL
;
506 /* --------------------------------------------------------------------------------------------- */
509 mc_closedir (DIR * dirp
)
511 int handle
= *(int *) dirp
;
512 struct vfs_class
*vfs
;
515 vfs
= vfs_class_find_by_handle (handle
);
518 vfs_path_element_t
*vfs_path_element
;
519 vfs_path_element
= vfs_class_data_find_by_handle (handle
);
520 if (vfs_path_element
->dir
.converter
!= str_cnv_from_term
)
522 str_close_conv (vfs_path_element
->dir
.converter
);
523 vfs_path_element
->dir
.converter
= INVALID_CONV
;
526 result
= vfs
->closedir
? (*vfs
->closedir
) (vfs_path_element
->dir
.info
) : -1;
527 vfs_free_handle (handle
);
528 vfs_path_element_free (vfs_path_element
);
534 /* --------------------------------------------------------------------------------------------- */
537 mc_stat (const vfs_path_t
* vpath
, struct stat
*buf
)
540 vfs_path_element_t
*path_element
;
545 path_element
= vfs_path_get_by_index (vpath
, -1);
547 if (vfs_path_element_valid (path_element
))
549 result
= path_element
->class->stat
? (*path_element
->class->stat
) (vpath
, buf
) : -1;
551 errno
= path_element
->class->name
? vfs_ferrno (path_element
->class) : E_NOTSUPP
;
557 /* --------------------------------------------------------------------------------------------- */
560 mc_lstat (const vfs_path_t
* vpath
, struct stat
*buf
)
563 vfs_path_element_t
*path_element
;
568 path_element
= vfs_path_get_by_index (vpath
, -1);
570 if (vfs_path_element_valid (path_element
))
572 result
= path_element
->class->lstat
? (*path_element
->class->lstat
) (vpath
, buf
) : -1;
574 errno
= path_element
->class->name
? vfs_ferrno (path_element
->class) : E_NOTSUPP
;
580 /* --------------------------------------------------------------------------------------------- */
583 mc_fstat (int handle
, struct stat
*buf
)
585 struct vfs_class
*vfs
;
591 vfs
= vfs_class_find_by_handle (handle
);
595 result
= vfs
->fstat
? (*vfs
->fstat
) (vfs_class_data_find_by_handle (handle
), buf
) : -1;
597 errno
= vfs
->name
? vfs_ferrno (vfs
) : E_NOTSUPP
;
601 /* --------------------------------------------------------------------------------------------- */
603 * Return current directory. If it's local, reread the current directory
604 * from the OS. Put directory to the provided buffer.
608 mc_get_current_wd (char *buffer
, size_t size
)
610 char *cwd
= _vfs_get_cwd ();
612 g_strlcpy (buffer
, cwd
, size
);
618 /* --------------------------------------------------------------------------------------------- */
621 mc_getlocalcopy (const char *pathname
)
625 vfs_path_element_t
*path_element
;
627 vpath
= vfs_path_from_str (pathname
);
631 path_element
= vfs_path_get_by_index (vpath
, -1);
633 if (vfs_path_element_valid (path_element
))
635 result
= path_element
->class->getlocalcopy
!= NULL
?
636 path_element
->class->getlocalcopy (vpath
) : mc_def_getlocalcopy (pathname
);
638 errno
= vfs_ferrno (path_element
->class);
640 vfs_path_free (vpath
);
644 /* --------------------------------------------------------------------------------------------- */
647 mc_ungetlocalcopy (const char *pathname
, const char *local
, int has_changed
)
649 int return_value
= -1;
651 vfs_path_element_t
*path_element
;
653 vpath
= vfs_path_from_str (pathname
);
657 path_element
= vfs_path_get_by_index (vpath
, -1);
659 if (vfs_path_element_valid (path_element
))
661 return_value
= path_element
->class->ungetlocalcopy
!= NULL
?
662 path_element
->class->ungetlocalcopy (vpath
, local
,
664 mc_def_ungetlocalcopy (path_element
->class, path_element
->path
, local
, has_changed
);
666 vfs_path_free (vpath
);
670 /* --------------------------------------------------------------------------------------------- */
674 * @param vpath VFS-path
676 * @return 0 on success, -1 on failure.
680 mc_chdir (const vfs_path_t
* vpath
)
682 struct vfs_class
*old_vfs
;
685 vfs_path_element_t
*path_element
;
690 path_element
= vfs_path_get_by_index (vpath
, -1);
692 if (!vfs_path_element_valid (path_element
) || path_element
->class->chdir
== NULL
)
697 result
= (*path_element
->class->chdir
) (vpath
);
701 errno
= vfs_ferrno (path_element
->class);
705 old_vfsid
= vfs_getid (vfs_get_raw_current_dir ());
706 old_vfs
= current_vfs
;
708 /* Actually change directory */
709 vfs_set_raw_current_dir (vfs_path_clone (vpath
));
710 current_vfs
= path_element
->class;
712 /* This function uses the new current_dir implicitly */
713 vfs_stamp_create (old_vfs
, old_vfsid
);
715 /* Sometimes we assume no trailing slash on cwd */
716 path_element
= vfs_path_get_by_index (vfs_get_raw_current_dir (), -1);
717 if (vfs_path_element_valid (path_element
) && (*path_element
->path
!= '\0'))
720 p
= strchr (path_element
->path
, 0) - 1;
721 if (*p
== PATH_SEP
&& p
> path_element
->path
)
727 /* --------------------------------------------------------------------------------------------- */
730 mc_lseek (int fd
, off_t offset
, int whence
)
732 struct vfs_class
*vfs
;
738 vfs
= vfs_class_find_by_handle (fd
);
742 result
= vfs
->lseek
? (*vfs
->lseek
) (vfs_class_data_find_by_handle (fd
), offset
, whence
) : -1;
744 errno
= vfs
->lseek
? vfs_ferrno (vfs
) : E_NOTSUPP
;
748 /* --------------------------------------------------------------------------------------------- */