Return values of following functions are constants now:
[midnight-commander.git] / lib / vfs / direntry.c
blob01c107bf45480d04b03f36dcbc8b27c754fe8d11
1 /*
2 Directory cache support
4 Copyright (C) 1998, 2011
5 The Free Software Foundation, Inc.
7 Written by:
8 Pavel Machek <pavel@ucw.cz>, 1998
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/>.
25 \warning Paths here do _not_ begin with '/', so root directory of
26 archive/site is simply "".
29 /** \file
30 * \brief Source: directory cache support
32 * So that you do not have copy of this in each and every filesystem.
34 * Very loosely based on tar.c from midnight and archives.[ch] from
35 * avfs by Miklos Szeredi (mszeredi@inf.bme.hu)
37 * Unfortunately, I was unable to keep all filesystems
38 * uniform. tar-like filesystems use tree structure where each
39 * directory has pointers to its subdirectories. We can do this
40 * because we have full information about our archive.
42 * At ftp-like filesystems, situation is a little bit different. When
43 * you cd /usr/src/linux/drivers/char, you do _not_ want /usr,
44 * /usr/src, /usr/src/linux and /usr/src/linux/drivers to be
45 * listed. That means that we do not have complete information, and if
46 * /usr is symlink to /4, we will not know. Also we have to time out
47 * entries and things would get messy with tree-like approach. So we
48 * do different trick: root directory is completely special and
49 * completely fake, it contains entries such as 'usr', 'usr/src', ...,
50 * and we'll try to use custom find_entry function.
52 * \author Pavel Machek <pavel@ucw.cz>
53 * \date 1998
57 #include <config.h>
59 #include <errno.h>
60 #include <fcntl.h> /* include fcntl.h -> sys/fcntl.h only */
61 /* includes fcntl.h see IEEE Std 1003.1-2008 */
62 #include <time.h>
63 #include <sys/time.h> /* gettimeofday() */
64 #include <inttypes.h> /* uintmax_t */
65 #include <stdarg.h>
67 #include "lib/global.h"
69 #include "lib/tty/tty.h" /* enable/disable interrupt key */
70 #include "lib/util.h" /* custom_canonicalize_pathname() */
71 #if 0
72 #include "lib/widget.h" /* message() */
73 #endif
75 #include "vfs.h"
76 #include "utilvfs.h"
77 #include "xdirentry.h"
78 #include "gc.h" /* vfs_rmstamp */
80 /*** global variables ****************************************************************************/
82 /*** file scope macro definitions ****************************************************************/
84 #define CALL(x) if (MEDATA->x) MEDATA->x
86 /*** file scope type declarations ****************************************************************/
88 struct dirhandle
90 GList *cur;
91 struct vfs_s_inode *dir;
94 /*** file scope variables ************************************************************************/
96 static volatile int total_inodes = 0, total_entries = 0;
98 /*** file scope functions ************************************************************************/
99 /* --------------------------------------------------------------------------------------------- */
101 static int
102 vfs_s_entry_compare (const void *a, const void *b)
104 const struct vfs_s_entry *e = (const struct vfs_s_entry *) a;
105 const char *name = (const char *) b;
107 return strcmp (e->name, name);
110 /* --------------------------------------------------------------------------------------------- */
112 /* We were asked to create entries automagically */
114 static struct vfs_s_entry *
115 vfs_s_automake (struct vfs_class *me, struct vfs_s_inode *dir, char *path, int flags)
117 struct vfs_s_entry *res;
118 char *sep;
120 sep = strchr (path, PATH_SEP);
121 if (sep != NULL)
122 *sep = '\0';
124 res = vfs_s_generate_entry (me, path, dir, flags & FL_MKDIR ? (0777 | S_IFDIR) : 0777);
125 vfs_s_insert_entry (me, dir, res);
127 if (sep != NULL)
128 *sep = PATH_SEP;
130 return res;
133 /* --------------------------------------------------------------------------------------------- */
134 /* If the entry is a symlink, find the entry for its target */
136 static struct vfs_s_entry *
137 vfs_s_resolve_symlink (struct vfs_class *me, struct vfs_s_entry *entry, int follow)
139 char *linkname;
140 char *fullname = NULL;
141 struct vfs_s_entry *target;
143 if (follow == LINK_NO_FOLLOW)
144 return entry;
145 if (follow == 0)
146 ERRNOR (ELOOP, NULL);
147 if (!entry)
148 ERRNOR (ENOENT, NULL);
149 if (!S_ISLNK (entry->ino->st.st_mode))
150 return entry;
152 linkname = entry->ino->linkname;
153 if (linkname == NULL)
154 ERRNOR (EFAULT, NULL);
156 /* make full path from relative */
157 if (*linkname != PATH_SEP)
159 char *fullpath = vfs_s_fullpath (me, entry->dir);
160 if (fullpath)
162 fullname = g_strconcat (fullpath, "/", linkname, (char *) NULL);
163 linkname = fullname;
164 g_free (fullpath);
168 target = (MEDATA->find_entry) (me, entry->dir->super->root, linkname, follow - 1, 0);
169 g_free (fullname);
170 return target;
173 /* --------------------------------------------------------------------------------------------- */
175 * Follow > 0: follow links, serves as loop protect,
176 * == -1: do not follow links
179 static struct vfs_s_entry *
180 vfs_s_find_entry_tree (struct vfs_class *me, struct vfs_s_inode *root,
181 const char *a_path, int follow, int flags)
183 size_t pseg;
184 struct vfs_s_entry *ent = NULL;
185 char *const pathref = g_strdup (a_path);
186 char *path = pathref;
188 /* canonicalize as well, but don't remove '../' from path */
189 custom_canonicalize_pathname (path, CANON_PATH_ALL & (~CANON_PATH_REMDOUBLEDOTS));
191 while (root != NULL)
193 GList *iter;
195 while (*path == PATH_SEP) /* Strip leading '/' */
196 path++;
198 if (path[0] == '\0')
200 g_free (pathref);
201 return ent;
204 for (pseg = 0; path[pseg] != '\0' && path[pseg] != PATH_SEP; pseg++)
207 for (iter = root->subdir; iter != NULL; iter = g_list_next (iter))
209 ent = (struct vfs_s_entry *) iter->data;
210 if (strlen (ent->name) == pseg && strncmp (ent->name, path, pseg) == 0)
211 /* FOUND! */
212 break;
215 ent = iter != NULL ? (struct vfs_s_entry *) iter->data : NULL;
217 if (ent == NULL && (flags & (FL_MKFILE | FL_MKDIR)) != 0)
218 ent = vfs_s_automake (me, root, path, flags);
219 if (ent == NULL)
221 me->verrno = ENOENT;
222 goto cleanup;
225 path += pseg;
226 /* here we must follow leading directories always;
227 only the actual file is optional */
228 ent = vfs_s_resolve_symlink (me, ent,
229 strchr (path, PATH_SEP) != NULL ? LINK_FOLLOW : follow);
230 if (ent == NULL)
231 goto cleanup;
232 root = ent->ino;
234 cleanup:
235 g_free (pathref);
236 return NULL;
239 /* --------------------------------------------------------------------------------------------- */
241 static struct vfs_s_entry *
242 vfs_s_find_entry_linear (struct vfs_class *me, struct vfs_s_inode *root,
243 const char *a_path, int follow, int flags)
245 struct vfs_s_entry *ent = NULL;
246 char *const path = g_strdup (a_path);
247 struct vfs_s_entry *retval = NULL;
248 GList *iter;
250 if (root->super->root != root)
251 vfs_die ("We have to use _real_ root. Always. Sorry.");
253 /* canonicalize as well, but don't remove '../' from path */
254 custom_canonicalize_pathname (path, CANON_PATH_ALL & (~CANON_PATH_REMDOUBLEDOTS));
256 if ((flags & FL_DIR) == 0)
258 char *dirname, *name;
259 struct vfs_s_inode *ino;
261 dirname = g_path_get_dirname (path);
262 name = g_path_get_basename (path);
263 ino = vfs_s_find_inode (me, root->super, dirname, follow, flags | FL_DIR);
264 retval = vfs_s_find_entry_tree (me, ino, name, follow, flags);
265 g_free (dirname);
266 g_free (name);
267 g_free (path);
268 return retval;
271 iter = g_list_find_custom (root->subdir, path, (GCompareFunc) vfs_s_entry_compare);
272 ent = iter != NULL ? (struct vfs_s_entry *) iter->data : NULL;
274 if (ent != NULL && !MEDATA->dir_uptodate (me, ent->ino))
276 #if 1
277 vfs_print_message (_("Directory cache expired for %s"), path);
278 #endif
279 vfs_s_free_entry (me, ent);
280 ent = NULL;
283 if (ent == NULL)
285 struct vfs_s_inode *ino;
287 ino = vfs_s_new_inode (me, root->super, vfs_s_default_stat (me, S_IFDIR | 0755));
288 ent = vfs_s_new_entry (me, path, ino);
289 if (MEDATA->dir_load (me, ino, path) == -1)
291 vfs_s_free_entry (me, ent);
292 g_free (path);
293 return NULL;
296 vfs_s_insert_entry (me, root, ent);
298 iter = g_list_find_custom (root->subdir, path, (GCompareFunc) vfs_s_entry_compare);
299 ent = iter != NULL ? (struct vfs_s_entry *) iter->data : NULL;
301 if (ent == NULL)
302 vfs_die ("find_linear: success but directory is not there\n");
304 #if 0
305 if (!vfs_s_resolve_symlink (me, ent, follow))
307 g_free (path);
308 return NULL;
310 #endif
311 g_free (path);
312 return ent;
315 /* --------------------------------------------------------------------------------------------- */
316 /* Ook, these were functions around directory entries / inodes */
317 /* -------------------------------- superblock games -------------------------- */
319 static struct vfs_s_super *
320 vfs_s_new_super (struct vfs_class *me)
322 struct vfs_s_super *super;
324 super = g_new0 (struct vfs_s_super, 1);
325 super->me = me;
326 return super;
329 /* --------------------------------------------------------------------------------------------- */
331 static inline void
332 vfs_s_insert_super (struct vfs_class *me, struct vfs_s_super *super)
334 MEDATA->supers = g_list_prepend (MEDATA->supers, super);
337 /* --------------------------------------------------------------------------------------------- */
339 static void
340 vfs_s_free_super (struct vfs_class *me, struct vfs_s_super *super)
342 if (super->root != NULL)
344 vfs_s_free_inode (me, super->root);
345 super->root = NULL;
348 #if 0
349 /* FIXME: We currently leak small ammount of memory, sometimes. Fix it if you can. */
350 if (super->ino_usage)
351 message (D_ERROR, "Direntry warning",
352 "Super ino_usage is %d, memory leak", super->ino_usage);
354 if (super->want_stale)
355 message (D_ERROR, "Direntry warning", "%s", "Super has want_stale set");
356 #endif
358 MEDATA->supers = g_list_remove (MEDATA->supers, super);
360 CALL (free_archive) (me, super);
361 #ifdef ENABLE_VFS_NET
362 vfs_path_element_free (super->path_element);
363 #endif
364 g_free (super->name);
365 g_free (super);
368 /* --------------------------------------------------------------------------------------------- */
369 /* Support of archives */
370 /* ------------------------ readdir & friends ----------------------------- */
372 static struct vfs_s_inode *
373 vfs_s_inode_from_path (const vfs_path_t * vpath, int flags)
375 struct vfs_s_super *super;
376 struct vfs_s_inode *ino;
377 const char *q;
378 const vfs_path_element_t *path_element;
380 q = vfs_s_get_path (vpath, &super, 0);
381 if (q == NULL)
382 return NULL;
384 path_element = vfs_path_get_by_index (vpath, -1);
386 ino =
387 vfs_s_find_inode (path_element->class, super, q,
388 flags & FL_FOLLOW ? LINK_FOLLOW : LINK_NO_FOLLOW, flags & ~FL_FOLLOW);
389 if ((!ino) && (!*q))
390 /* We are asking about / directory of ftp server: assume it exists */
391 ino =
392 vfs_s_find_inode (path_element->class, super, q,
393 flags & FL_FOLLOW ? LINK_FOLLOW :
394 LINK_NO_FOLLOW, FL_DIR | (flags & ~FL_FOLLOW));
395 return ino;
398 /* --------------------------------------------------------------------------------------------- */
400 static void *
401 vfs_s_opendir (const vfs_path_t * vpath)
403 struct vfs_s_inode *dir;
404 struct dirhandle *info;
405 const vfs_path_element_t *path_element;
407 path_element = vfs_path_get_by_index (vpath, -1);
409 dir = vfs_s_inode_from_path (vpath, FL_DIR | FL_FOLLOW);
410 if (dir == NULL)
411 return NULL;
412 if (!S_ISDIR (dir->st.st_mode))
414 path_element->class->verrno = ENOTDIR;
415 return NULL;
418 dir->st.st_nlink++;
419 #if 0
420 if (dir->subdir == NULL) /* This can actually happen if we allow empty directories */
422 path_element->class->verrno = EAGAIN;
423 return NULL;
425 #endif
426 info = g_new (struct dirhandle, 1);
427 info->cur = dir->subdir;
428 info->dir = dir;
430 return info;
433 /* --------------------------------------------------------------------------------------------- */
435 static void *
436 vfs_s_readdir (void *data)
438 static union vfs_dirent dir;
439 struct dirhandle *info = (struct dirhandle *) data;
440 const char *name;
442 if (info->cur == NULL || info->cur->data == NULL)
443 return NULL;
445 name = ((struct vfs_s_entry *) info->cur->data)->name;
446 if (name != NULL)
447 g_strlcpy (dir.dent.d_name, name, MC_MAXPATHLEN);
448 else
449 vfs_die ("Null in structure-cannot happen");
451 compute_namelen (&dir.dent);
452 info->cur = g_list_next (info->cur);
454 return (void *) &dir;
457 /* --------------------------------------------------------------------------------------------- */
459 static int
460 vfs_s_closedir (void *data)
462 struct dirhandle *info = (struct dirhandle *) data;
463 struct vfs_s_inode *dir = info->dir;
465 vfs_s_free_inode (dir->super->me, dir);
466 g_free (data);
467 return 0;
470 /* --------------------------------------------------------------------------------------------- */
472 static int
473 vfs_s_chdir (const vfs_path_t * vpath)
475 void *data;
477 data = vfs_s_opendir (vpath);
478 if (data == NULL)
479 return -1;
480 vfs_s_closedir (data);
481 return 0;
484 /* --------------------------------------------------------------------------------------------- */
485 /* --------------------------- stat and friends ---------------------------- */
487 static int
488 vfs_s_internal_stat (const vfs_path_t * vpath, struct stat *buf, int flag)
490 struct vfs_s_inode *ino;
492 ino = vfs_s_inode_from_path (vpath, flag);
493 if (ino == NULL)
494 return -1;
495 *buf = ino->st;
496 return 0;
499 /* --------------------------------------------------------------------------------------------- */
501 static int
502 vfs_s_stat (const vfs_path_t * vpath, struct stat *buf)
504 return vfs_s_internal_stat (vpath, buf, FL_FOLLOW);
507 /* --------------------------------------------------------------------------------------------- */
509 static int
510 vfs_s_lstat (const vfs_path_t * vpath, struct stat *buf)
512 return vfs_s_internal_stat (vpath, buf, FL_NONE);
515 /* --------------------------------------------------------------------------------------------- */
517 static int
518 vfs_s_fstat (void *fh, struct stat *buf)
520 *buf = FH->ino->st;
521 return 0;
524 /* --------------------------------------------------------------------------------------------- */
526 static int
527 vfs_s_readlink (const vfs_path_t * vpath, char *buf, size_t size)
529 struct vfs_s_inode *ino;
530 size_t len;
531 const vfs_path_element_t *path_element;
533 path_element = vfs_path_get_by_index (vpath, -1);
535 ino = vfs_s_inode_from_path (vpath, 0);
536 if (!ino)
537 return -1;
539 if (!S_ISLNK (ino->st.st_mode))
541 path_element->class->verrno = EINVAL;
542 return -1;
545 if (ino->linkname == NULL)
547 path_element->class->verrno = EFAULT;
548 return -1;
551 len = strlen (ino->linkname);
552 if (size < len)
553 len = size;
554 /* readlink() does not append a NUL character to buf */
555 memcpy (buf, ino->linkname, len);
556 return len;
559 /* --------------------------------------------------------------------------------------------- */
561 static ssize_t
562 vfs_s_read (void *fh, char *buffer, size_t count)
564 int n;
565 struct vfs_class *me = FH_SUPER->me;
567 if (FH->linear == LS_LINEAR_PREOPEN)
569 if (!MEDATA->linear_start (me, FH, FH->pos))
570 return -1;
573 if (FH->linear == LS_LINEAR_CLOSED)
574 vfs_die ("linear_start() did not set linear_state!");
576 if (FH->linear == LS_LINEAR_OPEN)
577 return MEDATA->linear_read (me, FH, buffer, count);
579 if (FH->handle != -1)
581 n = read (FH->handle, buffer, count);
582 if (n < 0)
583 me->verrno = errno;
584 return n;
586 vfs_die ("vfs_s_read: This should not happen\n");
587 return -1;
590 /* --------------------------------------------------------------------------------------------- */
592 static ssize_t
593 vfs_s_write (void *fh, const char *buffer, size_t count)
595 int n;
596 struct vfs_class *me = FH_SUPER->me;
598 if (FH->linear)
599 vfs_die ("no writing to linear files, please");
601 FH->changed = 1;
602 if (FH->handle != -1)
604 n = write (FH->handle, buffer, count);
605 if (n < 0)
606 me->verrno = errno;
607 return n;
609 vfs_die ("vfs_s_write: This should not happen\n");
610 return 0;
613 /* --------------------------------------------------------------------------------------------- */
615 static off_t
616 vfs_s_lseek (void *fh, off_t offset, int whence)
618 off_t size = FH->ino->st.st_size;
620 if (FH->linear == LS_LINEAR_OPEN)
621 vfs_die ("cannot lseek() after linear_read!");
623 if (FH->handle != -1)
624 { /* If we have local file opened, we want to work with it */
625 off_t retval = lseek (FH->handle, offset, whence);
626 if (retval == -1)
627 FH->ino->super->me->verrno = errno;
628 return retval;
631 switch (whence)
633 case SEEK_CUR:
634 offset += FH->pos;
635 break;
636 case SEEK_END:
637 offset += size;
638 break;
640 if (offset < 0)
641 FH->pos = 0;
642 else if (offset < size)
643 FH->pos = offset;
644 else
645 FH->pos = size;
646 return FH->pos;
649 /* --------------------------------------------------------------------------------------------- */
651 static int
652 vfs_s_close (void *fh)
654 int res = 0;
655 struct vfs_class *me = FH_SUPER->me;
657 FH_SUPER->fd_usage--;
658 if (!FH_SUPER->fd_usage)
659 vfs_stamp_create (me, FH_SUPER);
661 if (FH->linear == LS_LINEAR_OPEN)
662 MEDATA->linear_close (me, fh);
663 if (MEDATA->fh_close)
664 res = MEDATA->fh_close (me, fh);
665 if ((MEDATA->flags & VFS_S_USETMP) && FH->changed && MEDATA->file_store)
667 char *s = vfs_s_fullpath (me, FH->ino);
668 if (!s)
669 res = -1;
670 else
672 res = MEDATA->file_store (me, fh, s, FH->ino->localname);
673 g_free (s);
675 vfs_s_invalidate (me, FH_SUPER);
677 if (FH->handle != -1)
678 close (FH->handle);
680 vfs_s_free_inode (me, FH->ino);
681 if (MEDATA->fh_free_data != NULL)
682 MEDATA->fh_free_data (fh);
683 g_free (fh);
684 return res;
687 /* --------------------------------------------------------------------------------------------- */
689 static void
690 vfs_s_print_stats (const char *fs_name, const char *action,
691 const char *file_name, off_t have, off_t need)
693 static const char *i18n_percent_transf_format = NULL;
694 static const char *i18n_transf_format = NULL;
696 if (i18n_percent_transf_format == NULL)
698 i18n_percent_transf_format = "%s: %s: %s %3d%% (%" PRIuMAX " %s";
699 i18n_transf_format = "%s: %s: %s %" PRIuMAX " %s";
702 if (need)
703 vfs_print_message (i18n_percent_transf_format, fs_name, action,
704 file_name, (int) ((double) have * 100 / need), (uintmax_t) have,
705 _("bytes transferred"));
706 else
707 vfs_print_message (i18n_transf_format, fs_name, action, file_name, (uintmax_t) have,
708 _("bytes transferred"));
711 /* --------------------------------------------------------------------------------------------- */
712 /* ------------------------------- mc support ---------------------------- */
714 static void
715 vfs_s_fill_names (struct vfs_class *me, fill_names_f func)
717 GList *iter;
719 for (iter = MEDATA->supers; iter != NULL; iter = g_list_next (iter))
721 const struct vfs_s_super *super = (const struct vfs_s_super *) iter->data;
722 char *name;
724 name = g_strconcat (super->name, "/", me->prefix, VFS_PATH_URL_DELIMITER,
725 /* super->current_dir->name, */ (char *) NULL);
726 func (name);
727 g_free (name);
731 /* --------------------------------------------------------------------------------------------- */
733 static int
734 vfs_s_ferrno (struct vfs_class *me)
736 return me->verrno;
739 /* --------------------------------------------------------------------------------------------- */
741 * Get local copy of the given file. We reuse the existing file cache
742 * for remote filesystems. Archives use standard VFS facilities.
745 static vfs_path_t *
746 vfs_s_getlocalcopy (const vfs_path_t * vpath)
748 vfs_file_handler_t *fh;
749 vfs_path_t *local = NULL;
751 if (vpath == NULL)
752 return NULL;
754 fh = vfs_s_open (vpath, O_RDONLY, 0);
756 if (fh != NULL)
758 const struct vfs_class *me;
760 me = vfs_path_get_by_index (vpath, -1)->class;
761 if ((MEDATA->flags & VFS_S_USETMP) != 0 && (fh->ino != NULL))
762 local = vfs_path_from_str_flags (fh->ino->localname, VPF_NO_CANON);
764 vfs_s_close (fh);
767 return local;
770 /* --------------------------------------------------------------------------------------------- */
772 * Return the local copy. Since we are using our cache, we do nothing -
773 * the cache will be removed when the archive is closed.
776 static int
777 vfs_s_ungetlocalcopy (const vfs_path_t * vpath, const vfs_path_t * local, gboolean has_changed)
779 (void) vpath;
780 (void) local;
781 (void) has_changed;
782 return 0;
785 /* --------------------------------------------------------------------------------------------- */
787 static int
788 vfs_s_setctl (const vfs_path_t * vpath, int ctlop, void *arg)
790 const vfs_path_element_t *path_element;
792 path_element = vfs_path_get_by_index (vpath, -1);
794 switch (ctlop)
796 case VFS_SETCTL_STALE_DATA:
798 struct vfs_s_inode *ino;
800 ino = vfs_s_inode_from_path (vpath, 0);
801 if (ino == NULL)
802 return 0;
803 if (arg)
804 ino->super->want_stale = 1;
805 else
807 ino->super->want_stale = 0;
808 vfs_s_invalidate (path_element->class, ino->super);
810 return 1;
812 case VFS_SETCTL_LOGFILE:
813 ((struct vfs_s_subclass *) path_element->class->data)->logfile = fopen ((char *) arg, "w");
814 return 1;
815 case VFS_SETCTL_FLUSH:
816 ((struct vfs_s_subclass *) path_element->class->data)->flush = 1;
817 return 1;
819 return 0;
822 /* --------------------------------------------------------------------------------------------- */
823 /* ----------------------------- Stamping support -------------------------- */
825 static vfsid
826 vfs_s_getid (const vfs_path_t * vpath)
828 struct vfs_s_super *archive = NULL;
829 const char *p;
831 p = vfs_s_get_path (vpath, &archive, FL_NO_OPEN);
832 if (p == NULL)
833 return NULL;
835 return (vfsid) archive;
838 /* --------------------------------------------------------------------------------------------- */
840 static int
841 vfs_s_nothingisopen (vfsid id)
843 (void) id;
844 /* Our data structures should survive free of superblock at any time */
845 return 1;
848 /* --------------------------------------------------------------------------------------------- */
850 static void
851 vfs_s_free (vfsid id)
853 vfs_s_free_super (((struct vfs_s_super *) id)->me, (struct vfs_s_super *) id);
856 /* --------------------------------------------------------------------------------------------- */
858 static int
859 vfs_s_dir_uptodate (struct vfs_class *me, struct vfs_s_inode *ino)
861 struct timeval tim;
863 if (MEDATA->flush)
865 MEDATA->flush = 0;
866 return 0;
869 gettimeofday (&tim, NULL);
870 if (tim.tv_sec < ino->timestamp.tv_sec)
871 return 1;
872 return 0;
876 /* --------------------------------------------------------------------------------------------- */
877 /*** public functions ****************************************************************************/
878 /* --------------------------------------------------------------------------------------------- */
880 struct vfs_s_inode *
881 vfs_s_new_inode (struct vfs_class *me, struct vfs_s_super *super, struct stat *initstat)
883 struct vfs_s_inode *ino;
885 ino = g_try_new0 (struct vfs_s_inode, 1);
886 if (ino == NULL)
887 return NULL;
889 if (initstat)
890 ino->st = *initstat;
891 ino->super = super;
892 ino->st.st_nlink = 0;
893 ino->st.st_ino = MEDATA->inode_counter++;
894 ino->st.st_dev = MEDATA->rdev;
896 super->ino_usage++;
897 total_inodes++;
899 CALL (init_inode) (me, ino);
901 return ino;
904 /* --------------------------------------------------------------------------------------------- */
906 void
907 vfs_s_free_inode (struct vfs_class *me, struct vfs_s_inode *ino)
909 if (ino == NULL)
910 vfs_die ("Don't pass NULL to me");
912 /* ==0 can happen if freshly created entry is deleted */
913 if (ino->st.st_nlink > 1)
915 ino->st.st_nlink--;
916 return;
919 while (ino->subdir != NULL)
920 vfs_s_free_entry (me, (struct vfs_s_entry *) ino->subdir->data);
922 CALL (free_inode) (me, ino);
923 g_free (ino->linkname);
924 if ((MEDATA->flags & VFS_S_USETMP) != 0 && ino->localname != NULL)
926 unlink (ino->localname);
927 g_free (ino->localname);
929 total_inodes--;
930 ino->super->ino_usage--;
931 g_free (ino);
934 /* --------------------------------------------------------------------------------------------- */
936 struct vfs_s_entry *
937 vfs_s_new_entry (struct vfs_class *me, const char *name, struct vfs_s_inode *inode)
939 struct vfs_s_entry *entry;
941 entry = g_new0 (struct vfs_s_entry, 1);
942 total_entries++;
944 entry->name = g_strdup (name);
945 entry->ino = inode;
946 entry->ino->ent = entry;
947 CALL (init_entry) (me, entry);
949 return entry;
953 /* --------------------------------------------------------------------------------------------- */
955 void
956 vfs_s_free_entry (struct vfs_class *me, struct vfs_s_entry *ent)
958 if (ent->dir != NULL)
959 ent->dir->subdir = g_list_remove (ent->dir->subdir, ent);
961 g_free (ent->name);
962 /* ent->name = NULL; */
964 if (ent->ino != NULL)
966 ent->ino->ent = NULL;
967 vfs_s_free_inode (me, ent->ino);
970 total_entries--;
971 g_free (ent);
974 /* --------------------------------------------------------------------------------------------- */
976 void
977 vfs_s_insert_entry (struct vfs_class *me, struct vfs_s_inode *dir, struct vfs_s_entry *ent)
979 (void) me;
981 ent->dir = dir;
983 ent->ino->st.st_nlink++;
984 dir->subdir = g_list_append (dir->subdir, ent);
987 /* --------------------------------------------------------------------------------------------- */
989 struct stat *
990 vfs_s_default_stat (struct vfs_class *me, mode_t mode)
992 static struct stat st;
993 int myumask;
995 (void) me;
997 myumask = umask (022);
998 umask (myumask);
999 mode &= ~myumask;
1001 st.st_mode = mode;
1002 st.st_ino = 0;
1003 st.st_dev = 0;
1004 st.st_rdev = 0;
1005 st.st_uid = getuid ();
1006 st.st_gid = getgid ();
1007 st.st_size = 0;
1008 st.st_mtime = st.st_atime = st.st_ctime = time (NULL);
1010 return &st;
1013 /* --------------------------------------------------------------------------------------------- */
1015 struct vfs_s_entry *
1016 vfs_s_generate_entry (struct vfs_class *me, const char *name, struct vfs_s_inode *parent,
1017 mode_t mode)
1019 struct vfs_s_inode *inode;
1020 struct stat *st;
1022 st = vfs_s_default_stat (me, mode);
1023 inode = vfs_s_new_inode (me, parent->super, st);
1025 return vfs_s_new_entry (me, name, inode);
1028 /* --------------------------------------------------------------------------------------------- */
1030 struct vfs_s_inode *
1031 vfs_s_find_inode (struct vfs_class *me, const struct vfs_s_super *super,
1032 const char *path, int follow, int flags)
1034 struct vfs_s_entry *ent;
1036 if (((MEDATA->flags & VFS_S_REMOTE) == 0) && (*path == '\0'))
1037 return super->root;
1039 ent = (MEDATA->find_entry) (me, super->root, path, follow, flags);
1040 return (ent != NULL) ? ent->ino : NULL;
1043 /* --------------------------------------------------------------------------------------------- */
1044 /* Ook, these were functions around directory entries / inodes */
1045 /* -------------------------------- superblock games -------------------------- */
1047 * get path from last VFS-element and create corresponding superblock
1049 * @param vpath source path object
1050 * @param archive pointer to object for store newly created superblock
1051 * @param flags flags
1053 * @return path from last VFS-element
1055 const char *
1056 vfs_s_get_path (const vfs_path_t * vpath, struct vfs_s_super **archive, int flags)
1058 GList *iter;
1059 const char *retval;
1060 int result = -1;
1061 struct vfs_s_super *super;
1062 void *cookie = NULL;
1063 const vfs_path_element_t *path_element;
1064 vfs_path_t *vpath_archive;
1065 struct vfs_s_subclass *subclass;
1067 path_element = vfs_path_get_by_index (vpath, -1);
1068 subclass = ((struct vfs_s_subclass *) path_element->class->data);
1070 vpath_archive = vfs_path_clone (vpath);
1071 vfs_path_remove_element_by_index (vpath_archive, -1);
1073 retval = (path_element->path != NULL) ? path_element->path : "";
1075 if (subclass->archive_check != NULL)
1077 cookie = subclass->archive_check (vpath_archive);
1078 if (cookie == NULL)
1080 vfs_path_free (vpath_archive);
1081 return NULL;
1085 for (iter = subclass->supers; iter != NULL; iter = g_list_next (iter))
1087 int i;
1089 super = (struct vfs_s_super *) iter->data;
1091 /* 0 == other, 1 == same, return it, 2 == other but stop scanning */
1092 i = subclass->archive_same (path_element, super, vpath_archive, cookie);
1093 if (i != 0)
1095 if (i == 1)
1096 goto return_success;
1097 break;
1101 if (flags & FL_NO_OPEN)
1103 path_element->class->verrno = EIO;
1104 vfs_path_free (vpath_archive);
1105 return NULL;
1108 super = vfs_s_new_super (path_element->class);
1109 if (subclass->open_archive != NULL)
1110 result = subclass->open_archive (super, vpath_archive, path_element);
1111 if (result == -1)
1113 vfs_s_free_super (path_element->class, super);
1114 path_element->class->verrno = EIO;
1115 vfs_path_free (vpath_archive);
1116 return NULL;
1118 if (!super->name)
1119 vfs_die ("You have to fill name\n");
1120 if (!super->root)
1121 vfs_die ("You have to fill root inode\n");
1123 vfs_s_insert_super (path_element->class, super);
1124 vfs_stamp_create (path_element->class, super);
1126 return_success:
1127 *archive = super;
1128 vfs_path_free (vpath_archive);
1129 return retval;
1132 /* --------------------------------------------------------------------------------------------- */
1134 void
1135 vfs_s_invalidate (struct vfs_class *me, struct vfs_s_super *super)
1137 if (!super->want_stale)
1139 vfs_s_free_inode (me, super->root);
1140 super->root = vfs_s_new_inode (me, super, vfs_s_default_stat (me, S_IFDIR | 0755));
1144 /* --------------------------------------------------------------------------------------------- */
1146 char *
1147 vfs_s_fullpath (struct vfs_class *me, struct vfs_s_inode *ino)
1149 if (!ino->ent)
1150 ERRNOR (EAGAIN, NULL);
1152 if ((MEDATA->flags & VFS_S_USETMP) != 0)
1154 /* archives */
1155 char *newpath;
1156 char *path = g_strdup (ino->ent->name);
1157 while (1)
1159 ino = ino->ent->dir;
1160 if (ino == ino->super->root)
1161 break;
1162 newpath = g_strconcat (ino->ent->name, "/", path, (char *) NULL);
1163 g_free (path);
1164 path = newpath;
1166 return path;
1169 /* remote systems */
1170 if ((!ino->ent->dir) || (!ino->ent->dir->ent))
1171 return g_strdup (ino->ent->name);
1173 return g_strconcat (ino->ent->dir->ent->name, PATH_SEP_STR, ino->ent->name, (char *) NULL);
1176 /* --------------------------------------------------------------------------------------------- */
1177 /* --------------------------- stat and friends ---------------------------- */
1179 void *
1180 vfs_s_open (const vfs_path_t * vpath, int flags, mode_t mode)
1182 int was_changed = 0;
1183 vfs_file_handler_t *fh;
1184 struct vfs_s_super *super;
1185 const char *q;
1186 struct vfs_s_inode *ino;
1187 const vfs_path_element_t *path_element;
1189 path_element = vfs_path_get_by_index (vpath, -1);
1191 q = vfs_s_get_path (vpath, &super, 0);
1192 if (q == NULL)
1193 return NULL;
1194 ino = vfs_s_find_inode (path_element->class, super, q, LINK_FOLLOW, FL_NONE);
1195 if (ino && ((flags & (O_CREAT | O_EXCL)) == (O_CREAT | O_EXCL)))
1197 path_element->class->verrno = EEXIST;
1198 return NULL;
1200 if (!ino)
1202 char *dirname, *name;
1203 struct vfs_s_entry *ent;
1204 struct vfs_s_inode *dir;
1205 int tmp_handle;
1207 /* If the filesystem is read-only, disable file creation */
1208 if (!(flags & O_CREAT) || !(path_element->class->write))
1209 return NULL;
1211 dirname = g_path_get_dirname (q);
1212 name = g_path_get_basename (q);
1213 dir = vfs_s_find_inode (path_element->class, super, dirname, LINK_FOLLOW, FL_DIR);
1214 if (dir == NULL)
1216 g_free (dirname);
1217 g_free (name);
1218 return NULL;
1220 ent = vfs_s_generate_entry (path_element->class, name, dir, 0755);
1221 ino = ent->ino;
1222 vfs_s_insert_entry (path_element->class, dir, ent);
1223 if ((VFSDATA (path_element)->flags & VFS_S_USETMP) != 0)
1225 vfs_path_t *tmp_vpath;
1227 tmp_handle = vfs_mkstemps (&tmp_vpath, path_element->class->name, name);
1228 ino->localname = vfs_path_to_str (tmp_vpath);
1229 vfs_path_free (tmp_vpath);
1230 if (tmp_handle == -1)
1232 g_free (dirname);
1233 g_free (name);
1234 return NULL;
1237 close (tmp_handle);
1239 g_free (dirname);
1240 g_free (name);
1241 was_changed = 1;
1244 if (S_ISDIR (ino->st.st_mode))
1246 path_element->class->verrno = EISDIR;
1247 return NULL;
1250 fh = g_new (vfs_file_handler_t, 1);
1251 fh->pos = 0;
1252 fh->ino = ino;
1253 fh->handle = -1;
1254 fh->changed = was_changed;
1255 fh->linear = 0;
1256 fh->data = NULL;
1258 if (IS_LINEAR (flags))
1260 if (VFSDATA (path_element)->linear_start)
1262 vfs_print_message (_("Starting linear transfer..."));
1263 fh->linear = LS_LINEAR_PREOPEN;
1266 else
1268 struct vfs_s_subclass *s;
1270 s = VFSDATA (path_element);
1271 if (s->fh_open != NULL && s->fh_open (path_element->class, fh, flags, mode) != 0)
1273 if (s->fh_free_data != NULL)
1274 s->fh_free_data (fh);
1275 g_free (fh);
1276 return NULL;
1280 if ((VFSDATA (path_element)->flags & VFS_S_USETMP) != 0 && fh->ino->localname != NULL)
1282 fh->handle = open (fh->ino->localname, NO_LINEAR (flags), mode);
1283 if (fh->handle == -1)
1285 g_free (fh);
1286 path_element->class->verrno = errno;
1287 return NULL;
1291 /* i.e. we had no open files and now we have one */
1292 vfs_rmstamp (path_element->class, (vfsid) super);
1293 super->fd_usage++;
1294 fh->ino->st.st_nlink++;
1295 return fh;
1298 /* --------------------------------------------------------------------------------------------- */
1301 vfs_s_retrieve_file (struct vfs_class *me, struct vfs_s_inode *ino)
1303 /* If you want reget, you'll have to open file with O_LINEAR */
1304 off_t total = 0;
1305 char buffer[8192];
1306 int handle, n;
1307 off_t stat_size = ino->st.st_size;
1308 vfs_file_handler_t fh;
1309 vfs_path_t *tmp_vpath;
1311 if ((MEDATA->flags & VFS_S_USETMP) == 0)
1312 return -1;
1314 memset (&fh, 0, sizeof (fh));
1316 fh.ino = ino;
1317 fh.handle = -1;
1319 handle = vfs_mkstemps (&tmp_vpath, me->name, ino->ent->name);
1320 ino->localname = vfs_path_to_str (tmp_vpath);
1321 vfs_path_free (tmp_vpath);
1322 if (handle == -1)
1324 me->verrno = errno;
1325 goto error_4;
1328 if (!MEDATA->linear_start (me, &fh, 0))
1329 goto error_3;
1331 /* Clear the interrupt status */
1332 tty_got_interrupt ();
1333 tty_enable_interrupt_key ();
1335 while ((n = MEDATA->linear_read (me, &fh, buffer, sizeof (buffer))))
1337 int t;
1338 if (n < 0)
1339 goto error_1;
1341 total += n;
1342 vfs_s_print_stats (me->name, _("Getting file"), ino->ent->name, total, stat_size);
1344 if (tty_got_interrupt ())
1345 goto error_1;
1347 t = write (handle, buffer, n);
1348 if (t != n)
1350 if (t == -1)
1351 me->verrno = errno;
1352 goto error_1;
1355 MEDATA->linear_close (me, &fh);
1356 close (handle);
1358 tty_disable_interrupt_key ();
1359 g_free (fh.data);
1360 return 0;
1362 error_1:
1363 MEDATA->linear_close (me, &fh);
1364 error_3:
1365 tty_disable_interrupt_key ();
1366 close (handle);
1367 unlink (ino->localname);
1368 error_4:
1369 g_free (ino->localname);
1370 ino->localname = NULL;
1371 g_free (fh.data);
1372 return -1;
1375 /* --------------------------------------------------------------------------------------------- */
1376 /* ----------------------------- Stamping support -------------------------- */
1378 /* Initialize one of our subclasses - fill common functions */
1379 void
1380 vfs_s_init_class (struct vfs_class *vclass, struct vfs_s_subclass *sub)
1382 vclass->data = sub;
1383 vclass->fill_names = vfs_s_fill_names;
1384 vclass->open = vfs_s_open;
1385 vclass->close = vfs_s_close;
1386 vclass->read = vfs_s_read;
1387 if (!(sub->flags & VFS_S_READONLY))
1389 vclass->write = vfs_s_write;
1391 vclass->opendir = vfs_s_opendir;
1392 vclass->readdir = vfs_s_readdir;
1393 vclass->closedir = vfs_s_closedir;
1394 vclass->stat = vfs_s_stat;
1395 vclass->lstat = vfs_s_lstat;
1396 vclass->fstat = vfs_s_fstat;
1397 vclass->readlink = vfs_s_readlink;
1398 vclass->chdir = vfs_s_chdir;
1399 vclass->ferrno = vfs_s_ferrno;
1400 vclass->lseek = vfs_s_lseek;
1401 vclass->getid = vfs_s_getid;
1402 vclass->nothingisopen = vfs_s_nothingisopen;
1403 vclass->free = vfs_s_free;
1404 if ((sub->flags & VFS_S_USETMP) != 0)
1406 vclass->getlocalcopy = vfs_s_getlocalcopy;
1407 vclass->ungetlocalcopy = vfs_s_ungetlocalcopy;
1408 sub->find_entry = vfs_s_find_entry_linear;
1410 else if ((sub->flags & VFS_S_REMOTE) != 0)
1411 sub->find_entry = vfs_s_find_entry_linear;
1412 else
1413 sub->find_entry = vfs_s_find_entry_tree;
1414 vclass->setctl = vfs_s_setctl;
1415 sub->dir_uptodate = vfs_s_dir_uptodate;
1418 /* --------------------------------------------------------------------------------------------- */
1419 /** Find VFS id for given directory name */
1421 vfsid
1422 vfs_getid (const vfs_path_t * vpath)
1424 const vfs_path_element_t *path_element;
1426 path_element = vfs_path_get_by_index (vpath, -1);
1427 if (!vfs_path_element_valid (path_element) || path_element->class->getid == NULL)
1428 return NULL;
1430 return (*path_element->class->getid) (vpath);
1433 /* --------------------------------------------------------------------------------------------- */
1434 /* ----------- Utility functions for networked filesystems -------------- */
1436 #ifdef ENABLE_VFS_NET
1438 vfs_s_select_on_two (int fd1, int fd2)
1440 fd_set set;
1441 struct timeval time_out;
1442 int v;
1443 int maxfd = (fd1 > fd2 ? fd1 : fd2) + 1;
1445 time_out.tv_sec = 1;
1446 time_out.tv_usec = 0;
1447 FD_ZERO (&set);
1448 FD_SET (fd1, &set);
1449 FD_SET (fd2, &set);
1450 v = select (maxfd, &set, 0, 0, &time_out);
1451 if (v <= 0)
1452 return v;
1453 if (FD_ISSET (fd1, &set))
1454 return 1;
1455 if (FD_ISSET (fd2, &set))
1456 return 2;
1457 return -1;
1460 /* --------------------------------------------------------------------------------------------- */
1463 vfs_s_get_line (struct vfs_class *me, int sock, char *buf, int buf_len, char term)
1465 FILE *logfile = MEDATA->logfile;
1466 int i;
1467 char c;
1469 for (i = 0; i < buf_len - 1; i++, buf++)
1471 if (read (sock, buf, sizeof (char)) <= 0)
1472 return 0;
1473 if (logfile)
1475 size_t ret1;
1476 int ret2;
1477 ret1 = fwrite (buf, 1, 1, logfile);
1478 ret2 = fflush (logfile);
1480 if (*buf == term)
1482 *buf = 0;
1483 return 1;
1487 /* Line is too long - terminate buffer and discard the rest of line */
1488 *buf = 0;
1489 while (read (sock, &c, sizeof (c)) > 0)
1491 if (logfile)
1493 size_t ret1;
1494 int ret2;
1495 ret1 = fwrite (&c, 1, 1, logfile);
1496 ret2 = fflush (logfile);
1498 if (c == '\n')
1499 return 1;
1501 return 0;
1504 /* --------------------------------------------------------------------------------------------- */
1507 vfs_s_get_line_interruptible (struct vfs_class *me, char *buffer, int size, int fd)
1509 int n;
1510 int i;
1512 (void) me;
1514 tty_enable_interrupt_key ();
1515 for (i = 0; i < size - 1; i++)
1517 n = read (fd, buffer + i, 1);
1518 tty_disable_interrupt_key ();
1519 if (n == -1 && errno == EINTR)
1521 buffer[i] = 0;
1522 return EINTR;
1524 if (n == 0)
1526 buffer[i] = 0;
1527 return 0;
1529 if (buffer[i] == '\n')
1531 buffer[i] = 0;
1532 return 1;
1535 buffer[size - 1] = 0;
1536 return 0;
1538 #endif /* ENABLE_VFS_NET */
1540 /* --------------------------------------------------------------------------------------------- */
1542 * Normalize filenames start position
1545 void
1546 vfs_s_normalize_filename_leading_spaces (struct vfs_s_inode *root_inode, size_t final_num_spaces)
1548 GList *iter;
1550 for (iter = root_inode->subdir; iter != NULL; iter = g_list_next (iter))
1552 struct vfs_s_entry *entry = (struct vfs_s_entry *) iter->data;
1553 if ((size_t) entry->ino->data_offset > final_num_spaces)
1555 char *source_name = entry->name;
1556 char *spacer = g_strnfill (entry->ino->data_offset - final_num_spaces, ' ');
1557 entry->name = g_strdup_printf ("%s%s", spacer, source_name);
1558 g_free (spacer);
1559 g_free (source_name);
1561 entry->ino->data_offset = -1;
1565 /* --------------------------------------------------------------------------------------------- */