Use vfs_path_get_last_path_str() where it is resonable.
[midnight-commander.git] / src / vfs / undelfs / undelfs.c
blob18bfed73a3cb9d8441daaa8a6fc0b15d8c8fcb2e
1 /*
2 UnDel File System: Midnight Commander file system.
4 This file system is intended to be used together with the
5 ext2fs library to recover files from ext2fs file systems.
7 Parts of this program were taken from the lsdel.c and dump.c files
8 written by Ted Ts'o (tytso@mit.edu) for the ext2fs package.
10 Copyright (C) 1995-2023
11 Free Software Foundation, Inc.
13 Written by:
14 Miguel de Icaza, 1995
15 Norbert Warmuth, 1997
16 Pavel Machek, 2000
18 This file is part of the Midnight Commander.
20 The Midnight Commander is free software: you can redistribute it
21 and/or modify it under the terms of the GNU General Public License as
22 published by the Free Software Foundation, either version 3 of the License,
23 or (at your option) any later version.
25 The Midnight Commander is distributed in the hope that it will be useful,
26 but WITHOUT ANY WARRANTY; without even the implied warranty of
27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 GNU General Public License for more details.
30 You should have received a copy of the GNU General Public License
31 along with this program. If not, see <http://www.gnu.org/licenses/>.
34 /**
35 * \file
36 * \brief Source: UnDel File System
38 * Assumptions:
40 * 1. We don't handle directories (thus undelfs_get_path is easy to write).
41 * 2. Files are on the local file system (we do not support vfs files
42 * because we would have to provide an io_manager for the ext2fs tools,
43 * and I don't think it would be too useful to undelete files
46 #include <config.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h> /* memset() */
51 #include <ext2fs/ext2_fs.h>
52 #include <ext2fs/ext2fs.h>
53 #include <ctype.h>
55 #include "lib/global.h"
57 #include "lib/util.h"
58 #include "lib/widget.h" /* message() */
59 #include "lib/vfs/xdirentry.h"
60 #include "lib/vfs/utilvfs.h"
61 #include "lib/vfs/vfs.h"
63 #include "undelfs.h"
65 /*** global variables ****************************************************************************/
67 /*** file scope macro definitions ****************************************************************/
69 /* To generate the . and .. entries use -2 */
70 #define READDIR_PTR_INIT 0
72 #define undelfs_stat undelfs_lstat
74 /*** file scope type declarations ****************************************************************/
76 struct deleted_info
78 ext2_ino_t ino;
79 unsigned short mode;
80 unsigned short uid;
81 unsigned short gid;
82 unsigned long size;
83 time_t dtime;
84 int num_blocks;
85 int free_blocks;
88 struct lsdel_struct
90 ext2_ino_t inode;
91 int num_blocks;
92 int free_blocks;
93 int bad_blocks;
96 typedef struct
98 int f_index; /* file index into delarray */
99 char *buf;
100 int error_code; /* */
101 off_t pos; /* file position */
102 off_t current; /* used to determine current position in itereate */
103 gboolean finished;
104 ext2_ino_t inode;
105 int bytes_read;
106 off_t size;
108 /* Used by undelfs_read: */
109 char *dest_buffer; /* destination buffer */
110 size_t count; /* bytes to read */
111 } undelfs_file;
113 /*** forward declarations (file scope functions) *************************************************/
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;
128 static struct vfs_s_subclass undelfs_subclass;
129 static struct vfs_class *vfs_undelfs_ops = VFS_CLASS (&undelfs_subclass);
131 /* --------------------------------------------------------------------------------------------- */
132 /*** file scope functions ************************************************************************/
133 /* --------------------------------------------------------------------------------------------- */
135 static void
136 undelfs_shutdown (void)
138 if (fs)
139 ext2fs_close (fs);
140 fs = NULL;
141 MC_PTR_FREE (ext2_fname);
142 MC_PTR_FREE (delarray);
143 MC_PTR_FREE (block_buf);
146 /* --------------------------------------------------------------------------------------------- */
148 static void
149 undelfs_get_path (const vfs_path_t * vpath, char **fsname, char **file)
151 const char *p, *dirname;
153 dirname = vfs_path_get_last_path_str (vpath);
155 /* To look like filesystem, we have virtual directories
156 undel://XXX, which have no subdirectories. XXX is replaced with
157 hda5, sdb8 etc, which is assumed to live under /dev.
158 -- pavel@ucw.cz */
160 *fsname = NULL;
162 if (strncmp (dirname, "undel://", 8) != 0)
163 return;
165 dirname += 8;
167 /* Since we don't allow subdirectories, it's easy to get a filename,
168 * just scan backwards for a slash */
169 if (*dirname == '\0')
170 return;
172 p = dirname + strlen (dirname);
173 #if 0
174 /* Strip trailing ./
176 if (p - dirname > 2 && IS_PATH_SEP (p[-1]) && p[-2] == '.')
177 *(p = p - 2) = 0;
178 #endif
180 while (p > dirname)
182 if (IS_PATH_SEP (*p))
184 char *tmp;
186 *file = g_strdup (p + 1);
187 tmp = g_strndup (dirname, p - dirname);
188 *fsname = g_strconcat ("/dev/", tmp, (char *) NULL);
189 g_free (tmp);
190 return;
192 p--;
194 *file = g_strdup ("");
195 *fsname = g_strconcat ("/dev/", dirname, (char *) NULL);
198 /* --------------------------------------------------------------------------------------------- */
200 static int
201 undelfs_lsdel_proc (ext2_filsys _fs, blk_t * block_nr, int blockcnt, void *private)
203 struct lsdel_struct *_lsd = (struct lsdel_struct *) private;
204 (void) blockcnt;
205 _lsd->num_blocks++;
207 if (*block_nr < _fs->super->s_first_data_block || *block_nr >= _fs->super->s_blocks_count)
209 _lsd->bad_blocks++;
210 return BLOCK_ABORT;
213 if (!ext2fs_test_block_bitmap (_fs->block_map, *block_nr))
214 _lsd->free_blocks++;
216 return 0;
219 /* --------------------------------------------------------------------------------------------- */
221 * Load information about deleted files.
222 * Don't abort if there is not enough memory - load as much as we can.
225 static int
226 undelfs_loaddel (void)
228 int retval, count;
229 ext2_ino_t ino;
230 struct ext2_inode inode;
231 ext2_inode_scan scan;
233 max_delarray = 100;
234 num_delarray = 0;
235 delarray = g_try_malloc (sizeof (struct deleted_info) * max_delarray);
236 if (!delarray)
238 message (D_ERROR, undelfserr, "%s", _("not enough memory"));
239 return 0;
241 block_buf = g_try_malloc (fs->blocksize * 3);
242 if (!block_buf)
244 message (D_ERROR, undelfserr, "%s", _("while allocating block buffer"));
245 goto free_delarray;
247 retval = ext2fs_open_inode_scan (fs, 0, &scan);
248 if (retval != 0)
250 message (D_ERROR, undelfserr, _("open_inode_scan: %d"), retval);
251 goto free_block_buf;
253 retval = ext2fs_get_next_inode (scan, &ino, &inode);
254 if (retval != 0)
256 message (D_ERROR, undelfserr, _("while starting inode scan %d"), retval);
257 goto error_out;
259 count = 0;
260 while (ino)
262 if ((count++ % 1024) == 0)
263 vfs_print_message (_("undelfs: loading deleted files information %d inodes"), count);
264 if (inode.i_dtime == 0)
265 goto next;
267 if (S_ISDIR (inode.i_mode))
268 goto next;
270 lsd.inode = ino;
271 lsd.num_blocks = 0;
272 lsd.free_blocks = 0;
273 lsd.bad_blocks = 0;
275 retval = ext2fs_block_iterate (fs, ino, 0, block_buf, undelfs_lsdel_proc, &lsd);
276 if (retval)
278 message (D_ERROR, undelfserr, _("while calling ext2_block_iterate %d"), retval);
279 goto next;
281 if (lsd.free_blocks && !lsd.bad_blocks)
283 if (num_delarray >= max_delarray)
285 struct deleted_info *delarray_new = g_try_realloc (delarray,
286 sizeof (struct deleted_info) *
287 (max_delarray + 50));
288 if (!delarray_new)
290 message (D_ERROR, undelfserr, "%s",
291 _("no more memory while reallocating array"));
292 goto error_out;
294 delarray = delarray_new;
295 max_delarray += 50;
298 delarray[num_delarray].ino = ino;
299 delarray[num_delarray].mode = inode.i_mode;
300 delarray[num_delarray].uid = inode.i_uid;
301 delarray[num_delarray].gid = inode.i_gid;
302 delarray[num_delarray].size = inode.i_size;
303 delarray[num_delarray].dtime = inode.i_dtime;
304 delarray[num_delarray].num_blocks = lsd.num_blocks;
305 delarray[num_delarray].free_blocks = lsd.free_blocks;
306 num_delarray++;
309 next:
310 retval = ext2fs_get_next_inode (scan, &ino, &inode);
311 if (retval)
313 message (D_ERROR, undelfserr, _("while doing inode scan %d"), retval);
314 goto error_out;
317 readdir_ptr = READDIR_PTR_INIT;
318 ext2fs_close_inode_scan (scan);
319 return 1;
321 error_out:
322 ext2fs_close_inode_scan (scan);
323 free_block_buf:
324 MC_PTR_FREE (block_buf);
325 free_delarray:
326 MC_PTR_FREE (delarray);
327 return 0;
330 /* --------------------------------------------------------------------------------------------- */
332 static void *
333 undelfs_opendir (const vfs_path_t * vpath)
335 char *file, *f = NULL;
336 const vfs_path_element_t *path_element;
338 path_element = vfs_path_get_by_index (vpath, -1);
339 undelfs_get_path (vpath, &file, &f);
340 if (file == NULL)
342 g_free (f);
343 return 0;
346 /* We don't use the file name */
347 g_free (f);
349 if (!ext2_fname || strcmp (ext2_fname, file))
351 undelfs_shutdown ();
352 ext2_fname = file;
354 else
356 /* To avoid expensive re-scannings */
357 readdir_ptr = READDIR_PTR_INIT;
358 g_free (file);
359 return fs;
362 if (ext2fs_open (ext2_fname, 0, 0, 0, unix_io_manager, &fs))
364 message (D_ERROR, undelfserr, _("Cannot open file %s"), ext2_fname);
365 return 0;
367 vfs_print_message ("%s", _("undelfs: reading inode bitmap..."));
368 if (ext2fs_read_inode_bitmap (fs))
370 message (D_ERROR, undelfserr, _("Cannot load inode bitmap from:\n%s"), ext2_fname);
371 goto quit_opendir;
373 vfs_print_message ("%s", _("undelfs: reading block bitmap..."));
374 if (ext2fs_read_block_bitmap (fs))
376 message (D_ERROR, undelfserr, _("Cannot load block bitmap from:\n%s"), ext2_fname);
377 goto quit_opendir;
379 /* Now load the deleted information */
380 if (!undelfs_loaddel ())
381 goto quit_opendir;
382 vfs_print_message (_("%s: done."), path_element->class->name);
383 return fs;
384 quit_opendir:
385 vfs_print_message (_("%s: failure"), path_element->class->name);
386 ext2fs_close (fs);
387 fs = NULL;
388 return 0;
391 /* --------------------------------------------------------------------------------------------- */
393 static struct vfs_dirent *
394 undelfs_readdir (void *vfs_info)
396 struct vfs_dirent *dirent;
398 if (vfs_info != fs)
400 message (D_ERROR, undelfserr, "%s", _("vfs_info is not fs!"));
401 return NULL;
403 if (readdir_ptr == num_delarray)
404 return NULL;
405 if (readdir_ptr < 0)
406 dirent = vfs_dirent_init (NULL, readdir_ptr == -2 ? "." : "..", 0); /* FIXME: inode */
407 else
409 char dirent_dest[MC_MAXPATHLEN];
411 g_snprintf (dirent_dest, MC_MAXPATHLEN, "%ld:%d",
412 (long) delarray[readdir_ptr].ino, delarray[readdir_ptr].num_blocks);
413 dirent = vfs_dirent_init (NULL, dirent_dest, 0); /* FIXME: inode */
415 readdir_ptr++;
417 return dirent;
420 /* --------------------------------------------------------------------------------------------- */
422 static int
423 undelfs_closedir (void *vfs_info)
425 (void) vfs_info;
426 return 0;
429 /* --------------------------------------------------------------------------------------------- */
430 /* We do not support lseek */
432 static void *
433 undelfs_open (const vfs_path_t * vpath, int flags, mode_t mode)
435 char *file, *f = NULL;
436 ext2_ino_t inode, i;
437 undelfs_file *p = NULL;
438 (void) flags;
439 (void) mode;
441 /* Only allow reads on this file system */
442 undelfs_get_path (vpath, &file, &f);
443 if (file == NULL)
445 g_free (f);
446 return 0;
449 if (!ext2_fname || strcmp (ext2_fname, file))
451 message (D_ERROR, undelfserr, "%s", _("You have to chdir to extract files first"));
452 g_free (file);
453 g_free (f);
454 return 0;
456 inode = atol (f);
458 /* Search the file into delarray */
459 for (i = 0; i < (ext2_ino_t) num_delarray; i++)
461 if (inode != delarray[i].ino)
462 continue;
464 /* Found: setup all the structures needed by read */
465 p = (undelfs_file *) g_try_malloc (((gsize) sizeof (undelfs_file)));
466 if (!p)
468 g_free (file);
469 g_free (f);
470 return 0;
472 p->buf = g_try_malloc (fs->blocksize);
473 if (!p->buf)
475 g_free (p);
476 g_free (file);
477 g_free (f);
478 return 0;
480 p->inode = inode;
481 p->finished = FALSE;
482 p->f_index = i;
483 p->error_code = 0;
484 p->pos = 0;
485 p->size = delarray[i].size;
487 g_free (file);
488 g_free (f);
489 undelfs_usage++;
490 return p;
493 /* --------------------------------------------------------------------------------------------- */
495 static int
496 undelfs_close (void *vfs_info)
498 undelfs_file *p = vfs_info;
499 g_free (p->buf);
500 g_free (p);
501 undelfs_usage--;
502 return 0;
505 /* --------------------------------------------------------------------------------------------- */
507 static int
508 undelfs_dump_read (ext2_filsys param_fs, blk_t * blocknr, int blockcnt, void *private)
510 int copy_count;
511 undelfs_file *p = (undelfs_file *) private;
513 if (blockcnt < 0)
514 return 0;
516 if (*blocknr)
518 p->error_code = io_channel_read_blk (param_fs->io, *blocknr, 1, p->buf);
519 if (p->error_code)
520 return BLOCK_ABORT;
522 else
523 memset (p->buf, 0, param_fs->blocksize);
525 if (p->pos + (off_t) p->count < p->current)
527 p->finished = TRUE;
528 return BLOCK_ABORT;
530 if (p->pos > p->current + param_fs->blocksize)
532 p->current += param_fs->blocksize;
533 return 0; /* we have not arrived yet */
536 /* Now, we know we have to extract some data */
537 if (p->pos >= p->current)
540 /* First case: starting pointer inside this block */
541 if (p->pos + (off_t) p->count <= p->current + param_fs->blocksize)
543 /* Fully contained */
544 copy_count = p->count;
545 p->finished = (p->count != 0);
547 else
549 /* Still some more data */
550 copy_count = param_fs->blocksize - (p->pos - p->current);
552 memcpy (p->dest_buffer, p->buf + (p->pos - p->current), copy_count);
554 else
556 /* Second case: we already have passed p->pos */
557 if (p->pos + (off_t) p->count < p->current + param_fs->blocksize)
559 copy_count = (p->pos + p->count) - p->current;
560 p->finished = (p->count != 0);
562 else
564 copy_count = param_fs->blocksize;
566 memcpy (p->dest_buffer, p->buf, copy_count);
568 p->dest_buffer += copy_count;
569 p->current += param_fs->blocksize;
570 if (p->finished)
572 return BLOCK_ABORT;
574 return 0;
577 /* --------------------------------------------------------------------------------------------- */
579 static ssize_t
580 undelfs_read (void *vfs_info, char *buffer, size_t count)
582 undelfs_file *p = vfs_info;
583 int retval;
585 p->dest_buffer = buffer;
586 p->current = 0;
587 p->finished = FALSE;
588 p->count = count;
590 if (p->pos + (off_t) p->count > p->size)
592 p->count = p->size - p->pos;
594 retval = ext2fs_block_iterate (fs, p->inode, 0, NULL, undelfs_dump_read, p);
595 if (retval)
597 message (D_ERROR, undelfserr, "%s", _("while iterating over blocks"));
598 return -1;
600 if (p->error_code && !p->finished)
601 return 0;
602 p->pos = p->pos + (p->dest_buffer - buffer);
603 return p->dest_buffer - buffer;
606 /* --------------------------------------------------------------------------------------------- */
608 static long
609 undelfs_getindex (char *path)
611 ext2_ino_t inode = atol (path);
612 int i;
614 for (i = 0; i < num_delarray; i++)
616 if (delarray[i].ino == inode)
617 return i;
619 return -1;
622 /* --------------------------------------------------------------------------------------------- */
624 static int
625 undelfs_stat_int (int inode_index, struct stat *buf)
627 buf->st_dev = 0;
628 buf->st_ino = delarray[inode_index].ino;
629 buf->st_mode = delarray[inode_index].mode;
630 buf->st_nlink = 1;
631 buf->st_uid = delarray[inode_index].uid;
632 buf->st_gid = delarray[inode_index].gid;
633 buf->st_size = delarray[inode_index].size;
634 buf->st_atime = delarray[inode_index].dtime;
635 buf->st_ctime = delarray[inode_index].dtime;
636 buf->st_mtime = delarray[inode_index].dtime;
637 #ifdef HAVE_STRUCT_STAT_ST_MTIM
638 buf->st_atim.tv_nsec = buf->st_mtim.tv_nsec = buf->st_ctim.tv_nsec = 0;
639 #endif
640 return 0;
643 /* --------------------------------------------------------------------------------------------- */
645 static int
646 undelfs_lstat (const vfs_path_t * vpath, struct stat *buf)
648 int inode_index;
649 char *file, *f = NULL;
651 undelfs_get_path (vpath, &file, &f);
652 if (file == NULL)
654 g_free (f);
655 return 0;
658 /* When called from save_cwd_stats we get an incorrect file and f here:
659 e.g. incorrect correct
660 path = "undel:/dev/sda1" path="undel:/dev/sda1/401:1"
661 file = "/dev" file="/dev/sda1"
662 f = "sda1" f ="401:1"
663 If the first char in f is no digit -> return error */
664 if (!isdigit (*f))
666 g_free (file);
667 g_free (f);
668 return -1;
671 if (!ext2_fname || strcmp (ext2_fname, file))
673 g_free (file);
674 g_free (f);
675 message (D_ERROR, undelfserr, "%s", _("You have to chdir to extract files first"));
676 return 0;
678 inode_index = undelfs_getindex (f);
679 g_free (file);
680 g_free (f);
682 if (inode_index == -1)
683 return -1;
685 return undelfs_stat_int (inode_index, buf);
688 /* --------------------------------------------------------------------------------------------- */
690 static int
691 undelfs_fstat (void *vfs_info, struct stat *buf)
693 undelfs_file *p = vfs_info;
695 return undelfs_stat_int (p->f_index, buf);
698 /* --------------------------------------------------------------------------------------------- */
700 static int
701 undelfs_chdir (const vfs_path_t * vpath)
703 char *file, *f = NULL;
704 int fd;
706 undelfs_get_path (vpath, &file, &f);
707 if (file == NULL)
709 g_free (f);
710 return (-1);
713 /* We may use access because ext2 file systems are local */
714 /* this could be fixed by making an ext2fs io manager to use */
715 /* our vfs, but that is left as an exercise for the reader */
716 fd = open (file, O_RDONLY);
717 if (fd == -1)
719 message (D_ERROR, undelfserr, _("Cannot open file \"%s\""), file);
720 g_free (f);
721 g_free (file);
722 return -1;
724 close (fd);
725 g_free (f);
726 g_free (file);
727 return 0;
730 /* --------------------------------------------------------------------------------------------- */
732 /* this has to stay here for now: vfs layer does not know how to emulate it */
733 static off_t
734 undelfs_lseek (void *vfs_info, off_t offset, int whence)
736 (void) vfs_info;
737 (void) offset;
738 (void) whence;
740 return -1;
743 /* --------------------------------------------------------------------------------------------- */
745 static vfsid
746 undelfs_getid (const vfs_path_t * vpath)
748 char *fname = NULL, *fsname;
749 gboolean ok;
751 undelfs_get_path (vpath, &fsname, &fname);
752 ok = fsname != NULL;
754 g_free (fname);
755 g_free (fsname);
757 return ok ? (vfsid) fs : NULL;
760 /* --------------------------------------------------------------------------------------------- */
762 static gboolean
763 undelfs_nothingisopen (vfsid id)
765 (void) id;
767 return (undelfs_usage == 0);
770 /* --------------------------------------------------------------------------------------------- */
772 static void
773 undelfs_free (vfsid id)
775 (void) id;
777 undelfs_shutdown ();
780 /* --------------------------------------------------------------------------------------------- */
782 #ifdef ENABLE_NLS
783 static int
784 undelfs_init (struct vfs_class *me)
786 (void) me;
788 undelfserr = _(undelfserr);
789 return 1;
791 #else
792 #define undelfs_init NULL
793 #endif
795 /* --------------------------------------------------------------------------------------------- */
796 /*** public functions ****************************************************************************/
797 /* --------------------------------------------------------------------------------------------- */
799 * This function overrides com_err() from libcom_err library.
800 * It is used in libext2fs to report errors.
803 void
804 com_err (const char *whoami, long err_code, const char *fmt, ...)
806 va_list ap;
807 char *str;
809 va_start (ap, fmt);
810 str = g_strdup_vprintf (fmt, ap);
811 va_end (ap);
813 message (D_ERROR, _("Ext2lib error"), "%s (%s: %ld)", str, whoami, err_code);
814 g_free (str);
817 /* --------------------------------------------------------------------------------------------- */
819 void
820 vfs_init_undelfs (void)
822 /* NULLize vfs_s_subclass members */
823 memset (&undelfs_subclass, 0, sizeof (undelfs_subclass));
825 vfs_init_class (vfs_undelfs_ops, "undelfs", VFSF_UNKNOWN, "undel");
826 vfs_undelfs_ops->init = undelfs_init;
827 vfs_undelfs_ops->open = undelfs_open;
828 vfs_undelfs_ops->close = undelfs_close;
829 vfs_undelfs_ops->read = undelfs_read;
830 vfs_undelfs_ops->opendir = undelfs_opendir;
831 vfs_undelfs_ops->readdir = undelfs_readdir;
832 vfs_undelfs_ops->closedir = undelfs_closedir;
833 vfs_undelfs_ops->stat = undelfs_stat;
834 vfs_undelfs_ops->lstat = undelfs_lstat;
835 vfs_undelfs_ops->fstat = undelfs_fstat;
836 vfs_undelfs_ops->chdir = undelfs_chdir;
837 vfs_undelfs_ops->lseek = undelfs_lseek;
838 vfs_undelfs_ops->getid = undelfs_getid;
839 vfs_undelfs_ops->nothingisopen = undelfs_nothingisopen;
840 vfs_undelfs_ops->free = undelfs_free;
841 vfs_register_class (vfs_undelfs_ops);
844 /* --------------------------------------------------------------------------------------------- */