Following prototypes of functions was changed in VFS-module API:
[midnight-commander.git] / src / vfs / undelfs / undelfs.c
blobc3d915e6d7284d116f6244a124560892d418df30
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.
12 1997 Norbert Warmuth.
13 2000 Pavel Machek
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. */
29 /**
30 * \file
31 * \brief Source: UnDel File System
33 * Assumptions:
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
41 #include <config.h>
43 #include <errno.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <fcntl.h>
48 #ifdef HAVE_EXT2FS_EXT2_FS_H
49 #include <ext2fs/ext2_fs.h>
50 #else
51 /* asm/types.h defines its own umode_t */
52 #undef umode_t
53 #include <linux/ext2_fs.h>
54 #endif
56 #include <ext2fs/ext2fs.h>
57 #include <ctype.h>
59 #include "lib/global.h"
61 #include "lib/widget.h" /* message() */
62 #include "lib/vfs/utilvfs.h"
63 #include "lib/vfs/vfs.h"
65 #include "undelfs.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 ****************************************************************/
78 struct deleted_info
80 ext2_ino_t ino;
81 unsigned short mode;
82 unsigned short uid;
83 unsigned short gid;
84 unsigned long size;
85 time_t dtime;
86 int num_blocks;
87 int free_blocks;
90 struct lsdel_struct
92 ext2_ino_t inode;
93 int num_blocks;
94 int free_blocks;
95 int bad_blocks;
98 typedef struct
100 int f_index; /* file index into delarray */
101 char *buf;
102 int error_code; /* */
103 off_t pos; /* file position */
104 off_t current; /* used to determine current position in itereate */
105 gboolean finished;
106 ext2_ino_t inode;
107 int bytes_read;
108 off_t size;
110 /* Used by undelfs_read: */
111 char *dest_buffer; /* destination buffer */
112 size_t count; /* bytes to read */
113 } undelfs_file;
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 /* --------------------------------------------------------------------------------------------- */
132 static void
133 undelfs_shutdown (void)
135 if (fs)
136 ext2fs_close (fs);
137 fs = NULL;
138 g_free (ext2_fname);
139 ext2_fname = NULL;
140 g_free (delarray);
141 delarray = NULL;
142 g_free (block_buf);
143 block_buf = NULL;
146 /* --------------------------------------------------------------------------------------------- */
148 static void
149 undelfs_get_path (const char *dirname, char **fsname, char **file)
151 const char *p;
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.
156 -- pavel@ucw.cz */
158 *fsname = NULL;
160 if (strncmp (dirname, "/#undel:", 8))
161 return;
163 dirname += 8;
165 /* Since we don't allow subdirectories, it's easy to get a filename,
166 * just scan backwards for a slash */
167 if (*dirname == 0)
168 return;
170 p = dirname + strlen (dirname);
171 #if 0
172 /* Strip trailing ./
174 if (p - dirname > 2 && *(p - 1) == '/' && *(p - 2) == '.')
175 *(p = p - 2) = 0;
176 #endif
178 while (p > dirname)
180 if (*p == '/')
182 char *tmp;
184 *file = g_strdup (p + 1);
185 tmp = g_strndup (dirname, p - dirname);
186 *fsname = g_strconcat ("/dev/", tmp, (char *) NULL);
187 g_free (tmp);
188 return;
190 p--;
192 *file = g_strdup ("");
193 *fsname = g_strconcat ("/dev/", dirname, (char *) NULL);
194 return;
197 /* --------------------------------------------------------------------------------------------- */
199 static int
200 undelfs_lsdel_proc (ext2_filsys _fs, blk_t * block_nr, int blockcnt, void *private)
202 struct lsdel_struct *_lsd = (struct lsdel_struct *) private;
203 (void) blockcnt;
204 _lsd->num_blocks++;
206 if (*block_nr < _fs->super->s_first_data_block || *block_nr >= _fs->super->s_blocks_count)
208 _lsd->bad_blocks++;
209 return BLOCK_ABORT;
212 if (!ext2fs_test_block_bitmap (_fs->block_map, *block_nr))
213 _lsd->free_blocks++;
215 return 0;
218 /* --------------------------------------------------------------------------------------------- */
220 * Load information about deleted files.
221 * Don't abort if there is not enough memory - load as much as we can.
224 static int
225 undelfs_loaddel (void)
227 int retval, count;
228 ext2_ino_t ino;
229 struct ext2_inode inode;
230 ext2_inode_scan scan;
232 max_delarray = 100;
233 num_delarray = 0;
234 delarray = g_try_malloc (sizeof (struct deleted_info) * max_delarray);
235 if (!delarray)
237 message (D_ERROR, undelfserr, _("not enough memory"));
238 return 0;
240 block_buf = g_try_malloc (fs->blocksize * 3);
241 if (!block_buf)
243 message (D_ERROR, undelfserr, _("while allocating block buffer"));
244 goto free_delarray;
246 retval = ext2fs_open_inode_scan (fs, 0, &scan);
247 if (retval != 0)
249 message (D_ERROR, undelfserr, _("open_inode_scan: %d"), retval);
250 goto free_block_buf;
252 retval = ext2fs_get_next_inode (scan, &ino, &inode);
253 if (retval != 0)
255 message (D_ERROR, undelfserr, _("while starting inode scan %d"), retval);
256 goto error_out;
258 count = 0;
259 while (ino)
261 if ((count++ % 1024) == 0)
262 vfs_print_message (_("undelfs: loading deleted files information %d inodes"), count);
263 if (inode.i_dtime == 0)
264 goto next;
266 if (S_ISDIR (inode.i_mode))
267 goto next;
269 lsd.inode = ino;
270 lsd.num_blocks = 0;
271 lsd.free_blocks = 0;
272 lsd.bad_blocks = 0;
274 retval = ext2fs_block_iterate (fs, ino, 0, block_buf, undelfs_lsdel_proc, &lsd);
275 if (retval)
277 message (D_ERROR, undelfserr, _("while calling ext2_block_iterate %d"), retval);
278 goto next;
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));
287 if (!delarray_new)
289 message (D_ERROR, undelfserr, _("no more memory while reallocating array"));
290 goto error_out;
292 delarray = delarray_new;
293 max_delarray += 50;
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;
304 num_delarray++;
307 next:
308 retval = ext2fs_get_next_inode (scan, &ino, &inode);
309 if (retval)
311 message (D_ERROR, undelfserr, _("while doing inode scan %d"), retval);
312 goto error_out;
315 readdir_ptr = READDIR_PTR_INIT;
316 ext2fs_close_inode_scan (scan);
317 return 1;
319 error_out:
320 ext2fs_close_inode_scan (scan);
321 free_block_buf:
322 g_free (block_buf);
323 block_buf = NULL;
324 free_delarray:
325 g_free (delarray);
326 delarray = NULL;
327 return 0;
330 /* --------------------------------------------------------------------------------------------- */
332 static void *
333 undelfs_opendir (struct vfs_class *me, const char *dirname)
335 char *file, *f;
337 undelfs_get_path (dirname, &file, &f);
338 if (!file)
339 return 0;
341 /* We don't use the file name */
342 g_free (f);
344 if (!ext2_fname || strcmp (ext2_fname, file))
346 undelfs_shutdown ();
347 ext2_fname = file;
349 else
351 /* To avoid expensive re-scannings */
352 readdir_ptr = READDIR_PTR_INIT;
353 g_free (file);
354 return fs;
357 if (ext2fs_open (ext2_fname, 0, 0, 0, unix_io_manager, &fs))
359 message (D_ERROR, undelfserr, _("Cannot open file %s"), ext2_fname);
360 return 0;
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);
366 goto quit_opendir;
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);
372 goto quit_opendir;
374 /* Now load the deleted information */
375 if (!undelfs_loaddel ())
376 goto quit_opendir;
377 vfs_print_message (_("%s: done."), me->name);
378 return fs;
379 quit_opendir:
380 vfs_print_message (_("%s: failure"), me->name);
381 ext2fs_close (fs);
382 fs = NULL;
383 return 0;
386 /* --------------------------------------------------------------------------------------------- */
388 static void *
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;
394 if (vfs_info != fs)
396 message (D_ERROR, undelfserr, _("vfs_info is not fs!"));
397 return NULL;
399 if (readdir_ptr == num_delarray)
400 return NULL;
401 if (readdir_ptr < 0)
402 strcpy (dirent_dest, readdir_ptr == -2 ? "." : "..");
403 else
404 g_snprintf (dirent_dest, MC_MAXPATHLEN, "%ld:%d",
405 (long) delarray[readdir_ptr].ino, delarray[readdir_ptr].num_blocks);
406 readdir_ptr++;
408 compute_namelen (&undelfs_readdir_data.dent);
410 return &undelfs_readdir_data;
413 /* --------------------------------------------------------------------------------------------- */
415 static int
416 undelfs_closedir (void *vfs_info)
418 (void) vfs_info;
419 return 0;
422 /* --------------------------------------------------------------------------------------------- */
423 /* We do not support lseek */
425 static void *
426 undelfs_open (const vfs_path_t * vpath, int flags, mode_t mode)
428 char *file, *f;
429 ext2_ino_t inode, i;
430 undelfs_file *p = NULL;
431 (void) flags;
432 (void) mode;
434 /* Only allow reads on this file system */
435 undelfs_get_path (vpath->unparsed, &file, &f);
436 if (!file)
437 return 0;
439 if (!ext2_fname || strcmp (ext2_fname, file))
441 message (D_ERROR, undelfserr, _("You have to chdir to extract files first"));
442 g_free (file);
443 g_free (f);
444 return 0;
446 inode = atol (f);
448 /* Search the file into delarray */
449 for (i = 0; i < (ext2_ino_t) num_delarray; i++)
451 if (inode != delarray[i].ino)
452 continue;
454 /* Found: setup all the structures needed by read */
455 p = (undelfs_file *) g_try_malloc (((gsize) sizeof (undelfs_file)));
456 if (!p)
458 g_free (file);
459 g_free (f);
460 return 0;
462 p->buf = g_try_malloc (fs->blocksize);
463 if (!p->buf)
465 g_free (p);
466 g_free (file);
467 g_free (f);
468 return 0;
470 p->inode = inode;
471 p->finished = FALSE;
472 p->f_index = i;
473 p->error_code = 0;
474 p->pos = 0;
475 p->size = delarray[i].size;
477 g_free (file);
478 g_free (f);
479 undelfs_usage++;
480 return p;
483 /* --------------------------------------------------------------------------------------------- */
485 static int
486 undelfs_close (void *vfs_info)
488 undelfs_file *p = vfs_info;
489 g_free (p->buf);
490 g_free (p);
491 undelfs_usage--;
492 return 0;
495 /* --------------------------------------------------------------------------------------------- */
497 static int
498 undelfs_dump_read (ext2_filsys param_fs, blk_t * blocknr, int blockcnt, void *private)
500 int copy_count;
501 undelfs_file *p = (undelfs_file *) private;
503 if (blockcnt < 0)
504 return 0;
506 if (*blocknr)
508 p->error_code = io_channel_read_blk (param_fs->io, *blocknr, 1, p->buf);
509 if (p->error_code)
510 return BLOCK_ABORT;
512 else
513 memset (p->buf, 0, param_fs->blocksize);
515 if (p->pos + (off_t) p->count < p->current)
517 p->finished = TRUE;
518 return BLOCK_ABORT;
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);
537 else
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);
544 else
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);
552 else
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;
560 if (p->finished)
562 return BLOCK_ABORT;
564 return 0;
567 /* --------------------------------------------------------------------------------------------- */
569 static ssize_t
570 undelfs_read (void *vfs_info, char *buffer, size_t count)
572 undelfs_file *p = vfs_info;
573 int retval;
575 p->dest_buffer = buffer;
576 p->current = 0;
577 p->finished = FALSE;
578 p->count = count;
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);
585 if (retval)
587 message (D_ERROR, undelfserr, _("while iterating over blocks"));
588 return -1;
590 if (p->error_code && !p->finished)
591 return 0;
592 p->pos = p->pos + (p->dest_buffer - buffer);
593 return p->dest_buffer - buffer;
596 /* --------------------------------------------------------------------------------------------- */
598 static long
599 undelfs_getindex (char *path)
601 ext2_ino_t inode = atol (path);
602 int i;
604 for (i = 0; i < num_delarray; i++)
606 if (delarray[i].ino == inode)
607 return i;
609 return -1;
612 /* --------------------------------------------------------------------------------------------- */
614 static int
615 undelfs_stat_int (int inode_index, struct stat *buf)
617 buf->st_dev = 0;
618 buf->st_ino = delarray[inode_index].ino;
619 buf->st_mode = delarray[inode_index].mode;
620 buf->st_nlink = 1;
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;
627 return 0;
630 /* --------------------------------------------------------------------------------------------- */
632 static int
633 undelfs_lstat (struct vfs_class *me, const char *path, struct stat *buf)
635 int inode_index;
636 char *file, *f;
637 (void) me;
639 undelfs_get_path (path, &file, &f);
640 if (!file)
641 return 0;
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 */
649 if (!isdigit (*f))
651 g_free (file);
652 g_free (f);
653 return -1;
656 if (!ext2_fname || strcmp (ext2_fname, file))
658 message (D_ERROR, undelfserr, _("You have to chdir to extract files first"));
659 g_free (file);
660 g_free (f);
661 return 0;
663 inode_index = undelfs_getindex (f);
664 g_free (file);
665 g_free (f);
667 if (inode_index == -1)
668 return -1;
670 return undelfs_stat_int (inode_index, buf);
673 /* --------------------------------------------------------------------------------------------- */
675 static int
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 /* --------------------------------------------------------------------------------------------- */
685 static int
686 undelfs_chdir (struct vfs_class *me, const char *path)
688 char *file, *f;
689 int fd;
690 (void) me;
692 undelfs_get_path (path, &file, &f);
693 if (!file)
694 return -1;
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);
700 if (fd == -1)
702 message (D_ERROR, undelfserr, _("Cannot open file \"%s\""), file);
703 g_free (f);
704 g_free (file);
705 return -1;
707 close (fd);
708 g_free (f);
709 g_free (file);
710 return 0;
713 /* --------------------------------------------------------------------------------------------- */
715 /* this has to stay here for now: vfs layer does not know how to emulate it */
716 static off_t
717 undelfs_lseek (void *vfs_info, off_t offset, int whence)
719 (void) vfs_info;
720 (void) offset;
721 (void) whence;
723 return -1;
726 /* --------------------------------------------------------------------------------------------- */
728 static vfsid
729 undelfs_getid (struct vfs_class *me, const char *path)
731 char *fname, *fsname;
732 (void) me;
734 undelfs_get_path (path, &fsname, &fname);
736 if (!fsname)
737 return NULL;
738 g_free (fname);
739 g_free (fsname);
740 return (vfsid) fs;
743 /* --------------------------------------------------------------------------------------------- */
745 static int
746 undelfs_nothingisopen (vfsid id)
748 (void) id;
750 return !undelfs_usage;
753 /* --------------------------------------------------------------------------------------------- */
755 static void
756 undelfs_free (vfsid id)
758 (void) id;
760 undelfs_shutdown ();
763 /* --------------------------------------------------------------------------------------------- */
765 #ifdef ENABLE_NLS
766 static int
767 undelfs_init (struct vfs_class *me)
769 (void) me;
771 undelfserr = _(undelfserr);
772 return 1;
774 #else
775 #define undelfs_init NULL
776 #endif
778 /* --------------------------------------------------------------------------------------------- */
779 /*** public functions ****************************************************************************/
780 /* --------------------------------------------------------------------------------------------- */
782 * This function overrides com_err() from libcom_err library.
783 * It is used in libext2fs to report errors.
786 void
787 com_err (const char *whoami, long err_code, const char *fmt, ...)
789 va_list ap;
790 char *str;
792 va_start (ap, fmt);
793 str = g_strdup_vprintf (fmt, ap);
794 va_end (ap);
796 message (D_ERROR, _("Ext2lib error"), "%s (%s: %ld)", str, whoami, err_code);
797 g_free (str);
800 /* --------------------------------------------------------------------------------------------- */
802 void
803 init_undelfs (void)
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 /* --------------------------------------------------------------------------------------------- */