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