restore/main.c

   1 /*
   2  *      Ported to Linux's Second Extended File System as part of the
   3  *      dump and restore backup suit
   4  *      Remy Card <card@Linux.EU.Org>, 1994-1997
   5  *      Stelian Pop <pop@noos.fr>, 1999-2000
   6  *      Stelian Pop <pop@noos.fr> - Alcôve <www.alcove.fr>, 2000
   7  */
   8
   9 /*
  10  * Copyright (c) 1983, 1993
  11  *      The Regents of the University of California.  All rights reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *      This product includes software developed by the University of
  24  *      California, Berkeley and its contributors.
  25  * 4. Neither the name of the University nor the names of its contributors
  26  *    may be used to endorse or promote products derived from this software
  27  *    without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  39  * SUCH DAMAGE.
  40  */
  41
  42 #ifndef lint
  43 static const char rcsid[] =
  44         "$Id: main.c,v 1.27 2001/08/13 16:17:52 stelian Exp $";
  45 #endif /* not lint */
  46
  47 #include <config.h>
  48 #include <compatlfs.h>
  49 #include <sys/param.h>
  50 #include <sys/stat.h>
  51 #include <errno.h>
  52
  53 #ifdef  __linux__
  54 #include <sys/time.h>
  55 #include <time.h>
  56 #ifdef HAVE_EXT2FS_EXT2_FS_H
  57 #include <ext2fs/ext2_fs.h>
  58 #else
  59 #include <linux/ext2_fs.h>
  60 #endif
  61 #include <bsdcompat.h>
  62 #include <signal.h>
  63 #include <string.h>
  64 #else   /* __linux__ */
  65 #include <ufs/ufs/dinode.h>
  66 #endif  /* __linux__ */
  67 #include <protocols/dumprestore.h>
  68
  69 #include <compaterr.h>
  70 #include <stdio.h>
  71 #include <stdlib.h>
  72 #include <unistd.h>
  73
  74 #ifdef  __linux__
  75 #include <ext2fs/ext2fs.h>
  76 #include <getopt.h>
  77 #endif
  78
  79 #include "pathnames.h"
  80 #include "restore.h"
  81 #include "extern.h"
  82
  83 int     bflag = 0, cvtflag = 0, dflag = 0, vflag = 0, yflag = 0;
  84 int     hflag = 1, mflag = 1, Mflag = 0, Nflag = 0, zflag = 0;
  85 int     uflag = 0;
  86 int     dokerberos = 0;
  87 char    command = '\0';
  88 long    dumpnum = 1;
  89 long    volno = 0;
  90 long    ntrec;
  91 char    *dumpmap;
  92 char    *usedinomap;
  93 dump_ino_t maxino;
  94 time_t  dumptime;
  95 time_t  dumpdate;
  96 FILE    *terminal;
  97 char    *tmpdir;
  98 int     compare_ignore_not_found;
  99 int     compare_errors;
 100 char    filesys[NAMELEN];
 101 static const char *stdin_opt = NULL;
 102 char    *bot_script = NULL;
 103
 104 #ifdef USE_QFA
 105 FILE    *gTapeposfp;
 106 char    *gTapeposfile;
 107 char    gTps[255];
 108 long    gSeekstart;
 109 int     tapeposflag;
 110 #endif /* USE_QFA */
 111
 112 #ifdef  __linux__
 113 char    *__progname;
 114 #endif
 115
 116 static void obsolete __P((int *, char **[]));
 117 static void usage __P((void));
 118 static void use_stdin __P((const char *));
 119
 120 int
 121 main(int argc, char *argv[])
 122 {
 123         int ch;
 124         dump_ino_t ino;
 125         char *inputdev = _PATH_DEFTAPE;
 126         char *symtbl = "./restoresymtable";
 127         char *p, name[MAXPATHLEN];
 128         FILE *filelist = NULL;
 129         char fname[MAXPATHLEN];
 130 #ifdef USE_QFA
 131         tapeposflag = 0;
 132 #endif
 133 #ifdef USE_QFADEBUG
 134         time_t tistart, tiend, titaken;
 135 #endif
 136
 137         /* Temp files should *not* be readable.  We set permissions later. */
 138         (void) umask(077);
 139         filesys[0] = '\0';
 140 #ifdef  __linux__
 141         __progname = argv[0];
 142 #endif
 143
 144         if (argc < 2)
 145                 usage();
 146
 147         if ((inputdev = getenv("TAPE")) == NULL)
 148                 inputdev = _PATH_DEFTAPE;
 149         if ((tmpdir = getenv("TMPDIR")) == NULL)
 150                 tmpdir = _PATH_TMP;
 151         if ((tmpdir = strdup(tmpdir)) == NULL)
 152                 err(1, "malloc tmpdir");
 153         for (p = tmpdir + strlen(tmpdir) - 1; p >= tmpdir && *p == '/'; p--)
 154                 ;
 155         obsolete(&argc, &argv);
 156         while ((ch = getopt(argc, argv,
 157                 "b:CcdD:f:F:hi"
 158 #ifdef KERBEROS
 159                 "k"
 160 #endif
 161                 "mMN"
 162 #ifdef USE_QFA
 163                 "Q:"
 164 #endif
 165                 "Rrs:tT:uvxX:y")) != -1)
 166                 switch(ch) {
 167                 case 'b':
 168                         /* Change default tape blocksize. */
 169                         bflag = 1;
 170                         ntrec = strtol(optarg, &p, 10);
 171                         if (*p)
 172                                 errx(1, "illegal blocksize -- %s", optarg);
 173                         if (ntrec <= 0)
 174                                 errx(1, "block size must be greater than 0");
 175                         break;
 176                 case 'c':
 177                         cvtflag = 1;
 178                         break;
 179                 case 'D':
 180                         strncpy(filesys, optarg, NAMELEN);
 181                         filesys[NAMELEN - 1] = '\0';
 182                         break;
 183                 case 'T':
 184                         tmpdir = optarg;
 185                         break;
 186                 case 'd':
 187                         dflag = 1;
 188                         break;
 189                 case 'f':
 190                         if( !strcmp(optarg,"-") )
 191                                 use_stdin("-f");
 192                         inputdev = optarg;
 193                         break;
 194                 case 'F':
 195                         bot_script = optarg;
 196                         break;
 197                 case 'h':
 198                         hflag = 0;
 199                         break;
 200 #ifdef KERBEROS
 201                 case 'k':
 202                         dokerberos = 1;
 203                         break;
 204 #endif
 205                 case 'C':
 206                 case 'i':
 207                 case 'R':
 208                 case 'r':
 209                 case 't':
 210                 case 'x':
 211                         if (command != '\0')
 212                                 errx(1,
 213                                     "%c and %c options are mutually exclusive",
 214                                     ch, command);
 215                         command = ch;
 216                         break;
 217                 case 'm':
 218                         mflag = 0;
 219                         break;
 220                 case 'M':
 221                         Mflag = 1;
 222                         break;
 223                 case 'N':
 224                         Nflag = 1;
 225                         break;
 226 #ifdef USE_QFA
 227                 case 'Q':
 228                         gTapeposfile = optarg;
 229                         tapeposflag = 1;
 230                         break;
 231 #endif
 232                 case 's':
 233                         /* Dumpnum (skip to) for multifile dump tapes. */
 234                         dumpnum = strtol(optarg, &p, 10);
 235                         if (*p)
 236                                 errx(1, "illegal dump number -- %s", optarg);
 237                         if (dumpnum <= 0)
 238                                 errx(1, "dump number must be greater than 0");
 239                         break;
 240                 case 'u':
 241                         uflag = 1;
 242                         break;
 243                 case 'v':
 244                         vflag = 1;
 245                         break;
 246                 case 'X':
 247                         if( !strcmp(optarg,"-") ) {
 248                                 use_stdin("-X");
 249                                 filelist = stdin;
 250                         }
 251                         else
 252                                 if ( !(filelist = fopen(optarg,"r")) )
 253                                         errx(1, "can't open file for reading -- %s", optarg);
 254                         break;
 255                 case 'y':
 256                         yflag = 1;
 257                         break;
 258                 default:
 259                         usage();
 260                 }
 261         argc -= optind;
 262         argv += optind;
 263
 264         if (command == '\0')
 265                 errx(1, "none of C, i, R, r, t or x options specified");
 266
 267 #ifdef USE_QFA
 268         if (!mflag && tapeposflag)
 269                 errx(1, "m and Q options are mutually exclusive");
 270 #endif
 271
 272         if (signal(SIGINT, onintr) == SIG_IGN)
 273                 (void) signal(SIGINT, SIG_IGN);
 274         if (signal(SIGTERM, onintr) == SIG_IGN)
 275                 (void) signal(SIGTERM, SIG_IGN);
 276         setlinebuf(stderr);
 277
 278         atexit(cleanup);
 279
 280         setinput(inputdev);
 281
 282         if (argc == 0 && !filelist) {
 283                 argc = 1;
 284                 *--argv = ".";
 285         }
 286
 287 #ifdef USE_QFA
 288         if (tapeposflag) {
 289                 msg("reading QFA positions from %s\n", gTapeposfile);
 290                 if ((gTapeposfp = fopen(gTapeposfile, "r")) == NULL)
 291                         errx(1, "can't open file for reading -- %s",
 292                                 gTapeposfile);
 293                 /* start reading header info */
 294                 if (fgets(gTps, sizeof(gTps), gTapeposfp) == NULL)
 295                         errx(1, "not requested format of -- %s", gTapeposfile);
 296                 gTps[strlen(gTps) - 1] = 0;     /* delete end of line */
 297                 if (strcmp(gTps, QFA_MAGIC) != 0)
 298                         errx(1, "not requested format of -- %s", gTapeposfile);
 299                 if (fgets(gTps, sizeof(gTps), gTapeposfp) == NULL)
 300                         errx(1, "not requested format of -- %s", gTapeposfile);
 301                 gTps[strlen(gTps) - 1] = 0;
 302                 if (strcmp(gTps, QFA_VERSION) != 0)
 303                         errx(1, "not requested format of -- %s", gTapeposfile);
 304                 /* read dumpdate */
 305                 if (fgets(gTps, sizeof(gTps), gTapeposfp) == NULL)
 306                         errx(1, "not requested format of -- %s", gTapeposfile);
 307                 gTps[strlen(gTps) - 1] = 0;
 308                 /* TODO: check dumpdate from QFA file with current dump file's
 309                  * dump date */
 310                 /* if not equal either output warning and continue without QFA
 311                  * or abort */
 312                 /* read empty line */
 313                 if (fgets(gTps, sizeof(gTps), gTapeposfp) == NULL)
 314                         errx(1, "not requested format of -- %s", gTapeposfile);
 315                 gTps[strlen(gTps) - 1] = 0;
 316                 /* read table header line */
 317                 if (fgets(gTps, sizeof(gTps), gTapeposfp) == NULL)
 318                         errx(1, "not requested format of -- %s", gTapeposfile);
 319                 gTps[strlen(gTps) - 1] = 0;
 320                 /* end reading header info */
 321                 /* tape position table starts here */
 322                 gSeekstart = ftell(gTapeposfp); /* remember for later use */
 323 }
 324 #endif /* USE_QFA */
 325
 326         switch (command) {
 327         /*
 328          * Compare contents of tape.
 329          */
 330         case 'C': {
 331                 struct STAT stbuf;
 332
 333                 Vprintf(stdout, "Begin compare restore\n");
 334                 compare_ignore_not_found = 0;
 335                 compare_errors = 0;
 336                 setup();
 337                 printf("filesys = %s\n", filesys);
 338                 if (STAT(filesys, &stbuf) < 0)
 339                         err(1, "cannot stat directory %s", filesys);
 340                 if (chdir(filesys) < 0)
 341                         err(1, "cannot cd to %s", filesys);
 342                 compare_ignore_not_found = dumptime > 0;
 343                 initsymtable((char *)0);
 344                 extractdirs(0);
 345                 treescan(".", ROOTINO, nodeupdates);
 346                 compareleaves();
 347                 checkrestore();
 348                 if (compare_errors) {
 349                         printf("Some files were modified!\n");
 350                         exit(2);
 351                 }
 352                 break;
 353         }
 354
 355         /*
 356          * Interactive mode.
 357          */
 358         case 'i':
 359                 setup();
 360                 extractdirs(1);
 361                 initsymtable(NULL);
 362                 runcmdshell();
 363                 break;
 364         /*
 365          * Incremental restoration of a file system.
 366          */
 367         case 'r':
 368                 setup();
 369                 if (dumptime > 0) {
 370                         /*
 371                          * This is an incremental dump tape.
 372                          */
 373                         Vprintf(stdout, "Begin incremental restore\n");
 374                         initsymtable(symtbl);
 375                         extractdirs(1);
 376                         removeoldleaves();
 377                         Vprintf(stdout, "Calculate node updates.\n");
 378                         treescan(".", ROOTINO, nodeupdates);
 379                         findunreflinks();
 380                         removeoldnodes();
 381                 } else {
 382                         /*
 383                          * This is a level zero dump tape.
 384                          */
 385                         Vprintf(stdout, "Begin level 0 restore\n");
 386                         initsymtable((char *)0);
 387                         extractdirs(1);
 388                         Vprintf(stdout, "Calculate extraction list.\n");
 389                         treescan(".", ROOTINO, nodeupdates);
 390                 }
 391                 createleaves(symtbl);
 392                 createlinks();
 393                 setdirmodes(FORCE);
 394                 checkrestore();
 395                 if (dflag) {
 396                         Vprintf(stdout, "Verify the directory structure\n");
 397                         treescan(".", ROOTINO, verifyfile);
 398                 }
 399                 dumpsymtable(symtbl, (long)1);
 400                 break;
 401         /*
 402          * Resume an incremental file system restoration.
 403          */
 404         case 'R':
 405                 initsymtable(symtbl);
 406                 skipmaps();
 407                 skipdirs();
 408                 createleaves(symtbl);
 409                 createlinks();
 410                 setdirmodes(FORCE);
 411                 checkrestore();
 412                 dumpsymtable(symtbl, (long)1);
 413                 break;
 414
 415 /* handle file names from either text file (-X) or the command line */
 416 #define NEXTFILE(p) \
 417         p = NULL; \
 418         if (argc) { \
 419                 --argc; \
 420                 p = *argv++; \
 421         } \
 422         else if (filelist) { \
 423                 if ((p = fgets(fname, MAXPATHLEN, filelist))) { \
 424                         if ( *p && *(p + strlen(p) - 1) == '\n' ) /* possible null string */ \
 425                                 *(p + strlen(p) - 1) = '\0'; \
 426                         if ( !*p ) /* skip empty lines */ \
 427                                 continue; \
 428                         } \
 429         }
 430
 431         /*
 432          * List contents of tape.
 433          */
 434         case 't':
 435                 setup();
 436                 extractdirs(0);
 437                 initsymtable((char *)0);
 438                 for (;;) {
 439                         NEXTFILE(p);
 440                         if (!p)
 441                                 break;
 442                         canon(p, name, sizeof(name));
 443                         ino = dirlookup(name);
 444                         if (ino == 0)
 445                                 continue;
 446                         treescan(name, ino, listfile);
 447                 }
 448                 break;
 449         /*
 450          * Batch extraction of tape contents.
 451          */
 452         case 'x':
 453 #ifdef USE_QFADEBUG
 454                 tistart = time(NULL);
 455 #endif
 456                 setup();
 457                 extractdirs(1);
 458                 initsymtable((char *)0);
 459                 for (;;) {
 460                         NEXTFILE(p);
 461                         if (!p)
 462                                 break;
 463                         canon(p, name, sizeof(name));
 464                         ino = dirlookup(name);
 465                         if (ino == 0)
 466                                 continue;
 467                         if (mflag)
 468                                 pathcheck(name);
 469                         treescan(name, ino, addfile);
 470                 }
 471                 createfiles();
 472                 createlinks();
 473                 setdirmodes(0);
 474                 if (dflag)
 475                         checkrestore();
 476 #ifdef USE_QFADEBUG
 477                 tiend = time(NULL);
 478                 titaken = tiend - tistart;
 479                 msg("restore took %d:%02d:%02d\n", titaken / 3600,
 480                         (titaken % 3600) / 60, titaken % 60);
 481 #endif /* USE_QFADEBUG */
 482                 break;
 483         }
 484         exit(0);
 485         /* NOTREACHED */
 486         return 0;       /* gcc shut up */
 487 }
 488
 489 static void
 490 usage(void)
 491 {
 492 #ifdef __linux__
 493         const char *ext2ver, *ext2date;
 494
 495         ext2fs_get_library_version(&ext2ver, &ext2date);
 496         (void)fprintf(stderr, "%s %s (using libext2fs %s of %s)\n",
 497                       __progname, _DUMP_VERSION, ext2ver, ext2date);
 498 #else
 499         (void)fprintf(stderr, "%s %s\n", __progname, _DUMP_VERSION);
 500 #endif
 501
 502 #ifdef KERBEROS
 503 #define kerbflag "k"
 504 #else
 505 #define kerbflag
 506 #endif
 507
 508 #ifdef USE_QFA
 509 #define qfaflag "[-Q file] "
 510 #else
 511 #define qfaflag
 512 #endif
 513
 514         (void)fprintf(stderr,
 515           "usage:\t%s%s\n\t%s%s\n\t%s%s\n\t%s%s\n\t%s%s\n\t%s%s\n",
 516           __progname, " -C [-c" kerbflag "Mvy] [-b blocksize] [-D filesystem] [-f file] [-F script] [-s fileno]",
 517           __progname, " -i [-ch" kerbflag "mMuvy] [-b blocksize] [-f file] [-F script] " qfaflag "[-s fileno]",
 518           __progname, " -r [-c" kerbflag "Muvy] [-b blocksize] [-f file] [-F script] [-s fileno] [-T directory]",
 519           __progname, " -R [-c" kerbflag "Muvy] [-b blocksize] [-f file] [-F script] [-s fileno] [-T directory]",
 520           __progname, " -t [-ch" kerbflag "Muvy] [-b blocksize] [-f file] [-F script] " qfaflag "[-s fileno] [-X filelist] [file ...]",
 521           __progname, " -x [-ch" kerbflag "mMuvy] [-b blocksize] [-f file] [-F script] " qfaflag "[-s fileno] [-X filelist] [file ...]");
 522         exit(1);
 523 }
 524
 525 /*
 526  * obsolete --
 527  *      Change set of key letters and ordered arguments into something
 528  *      getopt(3) will like.
 529  */
 530 static void
 531 obsolete(int *argcp, char **argvp[])
 532 {
 533         int argc, flags;
 534         char *ap, **argv, *flagsp = NULL, **nargv, *p = NULL;
 535
 536         /* Setup. */
 537         argv = *argvp;
 538         argc = *argcp;
 539
 540         /* Return if no arguments or first argument has leading dash. */
 541         ap = argv[1];
 542         if (argc == 1 || *ap == '-')
 543                 return;
 544
 545         /* Allocate space for new arguments. */
 546         if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
 547             (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
 548                 err(1, "malloc args");
 549
 550         *nargv++ = *argv;
 551         argv += 2, argc -= 2;
 552
 553         for (flags = 0; *ap; ++ap) {
 554                 switch (*ap) {
 555                 case 'b':
 556                 case 'D':
 557                 case 'f':
 558                 case 'F':
 559                 case 'Q':
 560                 case 's':
 561                 case 'T':
 562                 case 'X':
 563                         if (*argv == NULL) {
 564                                 warnx("option requires an argument -- %c", *ap);
 565                                 usage();
 566                         }
 567                         if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
 568                                 err(1, "malloc arg");
 569                         nargv[0][0] = '-';
 570                         nargv[0][1] = *ap;
 571                         (void)strcpy(&nargv[0][2], *argv);
 572                         ++argv;
 573                         ++nargv;
 574                         break;
 575                 default:
 576                         if (!flags) {
 577                                 *p++ = '-';
 578                                 flags = 1;
 579                         }
 580                         *p++ = *ap;
 581                         break;
 582                 }
 583         }
 584
 585         /* Terminate flags. */
 586         if (flags) {
 587                 *p = '\0';
 588                 *nargv++ = flagsp;
 589         }
 590
 591         /* Copy remaining arguments. */
 592         while ((*nargv++ = *argv++));
 593
 594         /* Update argument count. */
 595         *argcp = nargv - *argvp - 1;
 596 }
 597
 598 /*
 599  * use_stdin --
 600  *      reserve stdin for opt (avoid conflicts)
 601  */
 602 void
 603 use_stdin(const char *opt)
 604 {
 605         if (stdin_opt)
 606                 errx(1, "can't handle standard input for both %s and %s",
 607                         stdin_opt, opt);
 608         stdin_opt = opt;
 609 }