1 /* UnDel File System: Midnight Commander file system.
3 This file system is intended to be used together with the
4 ext2fs library to recover files from ext2fs file systems.
6 Parts of this program were taken from the lsdel.c and dump.c files
7 written by Ted Ts'o (tytso@mit.edu) for the ext2fs package.
9 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
10 2005, 2007 Free Software Foundation, Inc.
11 Written by: 1995 Miguel de Icaza.
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU Library General Public License
17 as published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU Library General Public License for more details.
25 You should have received a copy of the GNU Library General Public
26 License along with this program; if not, write to the Free Software
27 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
31 * \brief Source: UnDel File System
35 * 1. We don't handle directories (thus undelfs_get_path is easy to write).
36 * 2. Files are on the local file system (we do not support vfs files
37 * because we would have to provide an io_manager for the ext2fs tools,
38 * and I don't think it would be too useful to undelete files
48 #ifdef HAVE_EXT2FS_EXT2_FS_H
49 #include <ext2fs/ext2_fs.h>
51 /* asm/types.h defines its own umode_t */
53 #include <linux/ext2_fs.h>
56 #include <ext2fs/ext2fs.h>
59 #include "lib/global.h"
61 #include "lib/widget.h" /* message() */
62 #include "lib/vfs/utilvfs.h"
63 #include "lib/vfs/vfs.h"
67 /*** global variables ****************************************************************************/
69 /*** file scope macro definitions ****************************************************************/
71 /* To generate the . and .. entries use -2 */
72 #define READDIR_PTR_INIT 0
74 #define undelfs_stat undelfs_lstat
76 /*** file scope type declarations ****************************************************************/
100 int f_index
; /* file index into delarray */
102 int error_code
; /* */
103 off_t pos
; /* file position */
104 off_t current
; /* used to determine current position in itereate */
110 /* Used by undelfs_read: */
111 char *dest_buffer
; /* destination buffer */
112 size_t count
; /* bytes to read */
115 /*** file scope variables ************************************************************************/
117 /* We only allow one opened ext2fs */
118 static char *ext2_fname
;
119 static ext2_filsys fs
= NULL
;
120 static struct lsdel_struct lsd
;
121 static struct deleted_info
*delarray
;
122 static int num_delarray
, max_delarray
;
123 static char *block_buf
;
124 static const char *undelfserr
= N_("undelfs: error");
125 static int readdir_ptr
;
126 static int undelfs_usage
;
127 static struct vfs_class vfs_undelfs_ops
;
129 /*** file scope functions ************************************************************************/
130 /* --------------------------------------------------------------------------------------------- */
133 undelfs_shutdown (void)
146 /* --------------------------------------------------------------------------------------------- */
149 undelfs_get_path (const char *dirname
, char **fsname
, char **file
)
153 /* To look like filesystem, we have virtual directories
154 /#undel:XXX, which have no subdirectories. XXX is replaced with
155 hda5, sdb8 etc, which is assumed to live under /dev.
160 if (strncmp (dirname
, "/#undel:", 8))
165 /* Since we don't allow subdirectories, it's easy to get a filename,
166 * just scan backwards for a slash */
170 p
= dirname
+ strlen (dirname
);
174 if (p
- dirname
> 2 && *(p
- 1) == '/' && *(p
- 2) == '.')
184 *file
= g_strdup (p
+ 1);
185 tmp
= g_strndup (dirname
, p
- dirname
);
186 *fsname
= g_strconcat ("/dev/", tmp
, (char *) NULL
);
192 *file
= g_strdup ("");
193 *fsname
= g_strconcat ("/dev/", dirname
, (char *) NULL
);
197 /* --------------------------------------------------------------------------------------------- */
200 undelfs_lsdel_proc (ext2_filsys _fs
, blk_t
* block_nr
, int blockcnt
, void *private)
202 struct lsdel_struct
*_lsd
= (struct lsdel_struct
*) private;
206 if (*block_nr
< _fs
->super
->s_first_data_block
|| *block_nr
>= _fs
->super
->s_blocks_count
)
212 if (!ext2fs_test_block_bitmap (_fs
->block_map
, *block_nr
))
218 /* --------------------------------------------------------------------------------------------- */
220 * Load information about deleted files.
221 * Don't abort if there is not enough memory - load as much as we can.
225 undelfs_loaddel (void)
229 struct ext2_inode inode
;
230 ext2_inode_scan scan
;
234 delarray
= g_try_malloc (sizeof (struct deleted_info
) * max_delarray
);
237 message (D_ERROR
, undelfserr
, _("not enough memory"));
240 block_buf
= g_try_malloc (fs
->blocksize
* 3);
243 message (D_ERROR
, undelfserr
, _("while allocating block buffer"));
246 retval
= ext2fs_open_inode_scan (fs
, 0, &scan
);
249 message (D_ERROR
, undelfserr
, _("open_inode_scan: %d"), retval
);
252 retval
= ext2fs_get_next_inode (scan
, &ino
, &inode
);
255 message (D_ERROR
, undelfserr
, _("while starting inode scan %d"), retval
);
261 if ((count
++ % 1024) == 0)
262 vfs_print_message (_("undelfs: loading deleted files information %d inodes"), count
);
263 if (inode
.i_dtime
== 0)
266 if (S_ISDIR (inode
.i_mode
))
274 retval
= ext2fs_block_iterate (fs
, ino
, 0, block_buf
, undelfs_lsdel_proc
, &lsd
);
277 message (D_ERROR
, undelfserr
, _("while calling ext2_block_iterate %d"), retval
);
280 if (lsd
.free_blocks
&& !lsd
.bad_blocks
)
282 if (num_delarray
>= max_delarray
)
284 struct deleted_info
*delarray_new
= g_try_realloc (delarray
,
285 sizeof (struct deleted_info
) *
286 (max_delarray
+ 50));
289 message (D_ERROR
, undelfserr
, _("no more memory while reallocating array"));
292 delarray
= delarray_new
;
296 delarray
[num_delarray
].ino
= ino
;
297 delarray
[num_delarray
].mode
= inode
.i_mode
;
298 delarray
[num_delarray
].uid
= inode
.i_uid
;
299 delarray
[num_delarray
].gid
= inode
.i_gid
;
300 delarray
[num_delarray
].size
= inode
.i_size
;
301 delarray
[num_delarray
].dtime
= inode
.i_dtime
;
302 delarray
[num_delarray
].num_blocks
= lsd
.num_blocks
;
303 delarray
[num_delarray
].free_blocks
= lsd
.free_blocks
;
308 retval
= ext2fs_get_next_inode (scan
, &ino
, &inode
);
311 message (D_ERROR
, undelfserr
, _("while doing inode scan %d"), retval
);
315 readdir_ptr
= READDIR_PTR_INIT
;
316 ext2fs_close_inode_scan (scan
);
320 ext2fs_close_inode_scan (scan
);
330 /* --------------------------------------------------------------------------------------------- */
333 undelfs_opendir (struct vfs_class
*me
, const char *dirname
)
337 undelfs_get_path (dirname
, &file
, &f
);
341 /* We don't use the file name */
344 if (!ext2_fname
|| strcmp (ext2_fname
, file
))
351 /* To avoid expensive re-scannings */
352 readdir_ptr
= READDIR_PTR_INIT
;
357 if (ext2fs_open (ext2_fname
, 0, 0, 0, unix_io_manager
, &fs
))
359 message (D_ERROR
, undelfserr
, _("Cannot open file %s"), ext2_fname
);
362 vfs_print_message (_("undelfs: reading inode bitmap..."));
363 if (ext2fs_read_inode_bitmap (fs
))
365 message (D_ERROR
, undelfserr
, _("Cannot load inode bitmap from:\n%s"), ext2_fname
);
368 vfs_print_message (_("undelfs: reading block bitmap..."));
369 if (ext2fs_read_block_bitmap (fs
))
371 message (D_ERROR
, undelfserr
, _("Cannot load block bitmap from:\n%s"), ext2_fname
);
374 /* Now load the deleted information */
375 if (!undelfs_loaddel ())
377 vfs_print_message (_("%s: done."), me
->name
);
380 vfs_print_message (_("%s: failure"), me
->name
);
386 /* --------------------------------------------------------------------------------------------- */
389 undelfs_readdir (void *vfs_info
)
391 static union vfs_dirent undelfs_readdir_data
;
392 static char *const dirent_dest
= undelfs_readdir_data
.dent
.d_name
;
396 message (D_ERROR
, undelfserr
, _("vfs_info is not fs!"));
399 if (readdir_ptr
== num_delarray
)
402 strcpy (dirent_dest
, readdir_ptr
== -2 ? "." : "..");
404 g_snprintf (dirent_dest
, MC_MAXPATHLEN
, "%ld:%d",
405 (long) delarray
[readdir_ptr
].ino
, delarray
[readdir_ptr
].num_blocks
);
408 compute_namelen (&undelfs_readdir_data
.dent
);
410 return &undelfs_readdir_data
;
413 /* --------------------------------------------------------------------------------------------- */
416 undelfs_closedir (void *vfs_info
)
422 /* --------------------------------------------------------------------------------------------- */
423 /* We do not support lseek */
426 undelfs_open (const vfs_path_t
* vpath
, int flags
, mode_t mode
)
430 undelfs_file
*p
= NULL
;
434 /* Only allow reads on this file system */
435 undelfs_get_path (vpath
->unparsed
, &file
, &f
);
439 if (!ext2_fname
|| strcmp (ext2_fname
, file
))
441 message (D_ERROR
, undelfserr
, _("You have to chdir to extract files first"));
448 /* Search the file into delarray */
449 for (i
= 0; i
< (ext2_ino_t
) num_delarray
; i
++)
451 if (inode
!= delarray
[i
].ino
)
454 /* Found: setup all the structures needed by read */
455 p
= (undelfs_file
*) g_try_malloc (((gsize
) sizeof (undelfs_file
)));
462 p
->buf
= g_try_malloc (fs
->blocksize
);
475 p
->size
= delarray
[i
].size
;
483 /* --------------------------------------------------------------------------------------------- */
486 undelfs_close (void *vfs_info
)
488 undelfs_file
*p
= vfs_info
;
495 /* --------------------------------------------------------------------------------------------- */
498 undelfs_dump_read (ext2_filsys param_fs
, blk_t
* blocknr
, int blockcnt
, void *private)
501 undelfs_file
*p
= (undelfs_file
*) private;
508 p
->error_code
= io_channel_read_blk (param_fs
->io
, *blocknr
, 1, p
->buf
);
513 memset (p
->buf
, 0, param_fs
->blocksize
);
515 if (p
->pos
+ (off_t
) p
->count
< p
->current
)
520 if (p
->pos
> p
->current
+ param_fs
->blocksize
)
522 p
->current
+= param_fs
->blocksize
;
523 return 0; /* we have not arrived yet */
526 /* Now, we know we have to extract some data */
527 if (p
->pos
>= p
->current
)
530 /* First case: starting pointer inside this block */
531 if (p
->pos
+ (off_t
) p
->count
<= p
->current
+ param_fs
->blocksize
)
533 /* Fully contained */
534 copy_count
= p
->count
;
535 p
->finished
= (p
->count
!= 0);
539 /* Still some more data */
540 copy_count
= param_fs
->blocksize
- (p
->pos
- p
->current
);
542 memcpy (p
->dest_buffer
, p
->buf
+ (p
->pos
- p
->current
), copy_count
);
546 /* Second case: we already have passed p->pos */
547 if (p
->pos
+ (off_t
) p
->count
< p
->current
+ param_fs
->blocksize
)
549 copy_count
= (p
->pos
+ p
->count
) - p
->current
;
550 p
->finished
= (p
->count
!= 0);
554 copy_count
= param_fs
->blocksize
;
556 memcpy (p
->dest_buffer
, p
->buf
, copy_count
);
558 p
->dest_buffer
+= copy_count
;
559 p
->current
+= param_fs
->blocksize
;
567 /* --------------------------------------------------------------------------------------------- */
570 undelfs_read (void *vfs_info
, char *buffer
, size_t count
)
572 undelfs_file
*p
= vfs_info
;
575 p
->dest_buffer
= buffer
;
580 if (p
->pos
+ (off_t
) p
->count
> p
->size
)
582 p
->count
= p
->size
- p
->pos
;
584 retval
= ext2fs_block_iterate (fs
, p
->inode
, 0, NULL
, undelfs_dump_read
, p
);
587 message (D_ERROR
, undelfserr
, _("while iterating over blocks"));
590 if (p
->error_code
&& !p
->finished
)
592 p
->pos
= p
->pos
+ (p
->dest_buffer
- buffer
);
593 return p
->dest_buffer
- buffer
;
596 /* --------------------------------------------------------------------------------------------- */
599 undelfs_getindex (char *path
)
601 ext2_ino_t inode
= atol (path
);
604 for (i
= 0; i
< num_delarray
; i
++)
606 if (delarray
[i
].ino
== inode
)
612 /* --------------------------------------------------------------------------------------------- */
615 undelfs_stat_int (int inode_index
, struct stat
*buf
)
618 buf
->st_ino
= delarray
[inode_index
].ino
;
619 buf
->st_mode
= delarray
[inode_index
].mode
;
621 buf
->st_uid
= delarray
[inode_index
].uid
;
622 buf
->st_gid
= delarray
[inode_index
].gid
;
623 buf
->st_size
= delarray
[inode_index
].size
;
624 buf
->st_atime
= delarray
[inode_index
].dtime
;
625 buf
->st_ctime
= delarray
[inode_index
].dtime
;
626 buf
->st_mtime
= delarray
[inode_index
].dtime
;
630 /* --------------------------------------------------------------------------------------------- */
633 undelfs_lstat (struct vfs_class
*me
, const char *path
, struct stat
*buf
)
639 undelfs_get_path (path
, &file
, &f
);
643 /* When called from save_cwd_stats we get an incorrect file and f here:
644 e.g. incorrect correct
645 path = "undel:/dev/sda1" path="undel:/dev/sda1/401:1"
646 file = "/dev" file="/dev/sda1"
647 f = "sda1" f ="401:1"
648 If the first char in f is no digit -> return error */
656 if (!ext2_fname
|| strcmp (ext2_fname
, file
))
658 message (D_ERROR
, undelfserr
, _("You have to chdir to extract files first"));
663 inode_index
= undelfs_getindex (f
);
667 if (inode_index
== -1)
670 return undelfs_stat_int (inode_index
, buf
);
673 /* --------------------------------------------------------------------------------------------- */
676 undelfs_fstat (void *vfs_info
, struct stat
*buf
)
678 undelfs_file
*p
= vfs_info
;
680 return undelfs_stat_int (p
->f_index
, buf
);
683 /* --------------------------------------------------------------------------------------------- */
686 undelfs_chdir (struct vfs_class
*me
, const char *path
)
692 undelfs_get_path (path
, &file
, &f
);
696 /* We may use access because ext2 file systems are local */
697 /* this could be fixed by making an ext2fs io manager to use */
698 /* our vfs, but that is left as an excercise for the reader */
699 fd
= open (file
, O_RDONLY
);
702 message (D_ERROR
, undelfserr
, _("Cannot open file \"%s\""), file
);
713 /* --------------------------------------------------------------------------------------------- */
715 /* this has to stay here for now: vfs layer does not know how to emulate it */
717 undelfs_lseek (void *vfs_info
, off_t offset
, int whence
)
726 /* --------------------------------------------------------------------------------------------- */
729 undelfs_getid (struct vfs_class
*me
, const char *path
)
731 char *fname
, *fsname
;
734 undelfs_get_path (path
, &fsname
, &fname
);
743 /* --------------------------------------------------------------------------------------------- */
746 undelfs_nothingisopen (vfsid id
)
750 return !undelfs_usage
;
753 /* --------------------------------------------------------------------------------------------- */
756 undelfs_free (vfsid id
)
763 /* --------------------------------------------------------------------------------------------- */
767 undelfs_init (struct vfs_class
*me
)
771 undelfserr
= _(undelfserr
);
775 #define undelfs_init NULL
778 /* --------------------------------------------------------------------------------------------- */
779 /*** public functions ****************************************************************************/
780 /* --------------------------------------------------------------------------------------------- */
782 * This function overrides com_err() from libcom_err library.
783 * It is used in libext2fs to report errors.
787 com_err (const char *whoami
, long err_code
, const char *fmt
, ...)
793 str
= g_strdup_vprintf (fmt
, ap
);
796 message (D_ERROR
, _("Ext2lib error"), "%s (%s: %ld)", str
, whoami
, err_code
);
800 /* --------------------------------------------------------------------------------------------- */
805 vfs_undelfs_ops
.name
= "undelfs";
806 vfs_undelfs_ops
.prefix
= "undel:";
807 vfs_undelfs_ops
.init
= undelfs_init
;
808 vfs_undelfs_ops
.open
= undelfs_open
;
809 vfs_undelfs_ops
.close
= undelfs_close
;
810 vfs_undelfs_ops
.read
= undelfs_read
;
811 vfs_undelfs_ops
.opendir
= undelfs_opendir
;
812 vfs_undelfs_ops
.readdir
= undelfs_readdir
;
813 vfs_undelfs_ops
.closedir
= undelfs_closedir
;
814 vfs_undelfs_ops
.stat
= undelfs_stat
;
815 vfs_undelfs_ops
.lstat
= undelfs_lstat
;
816 vfs_undelfs_ops
.fstat
= undelfs_fstat
;
817 vfs_undelfs_ops
.chdir
= undelfs_chdir
;
818 vfs_undelfs_ops
.lseek
= undelfs_lseek
;
819 vfs_undelfs_ops
.getid
= undelfs_getid
;
820 vfs_undelfs_ops
.nothingisopen
= undelfs_nothingisopen
;
821 vfs_undelfs_ops
.free
= undelfs_free
;
822 vfs_register_class (&vfs_undelfs_ops
);
825 /* --------------------------------------------------------------------------------------------- */