]> git.wh0rd.org Git - dump.git/blob - dump/optr.c
fd01cac08ae0900bc4125662e46859b5ed80effe
[dump.git] / dump / optr.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@cybercable.fr>, 1999-2000
6  *      Stelian Pop <pop@cybercable.fr> - AlcĂ´ve <www.alcove.fr>, 2000
7  */
8
9 /*-
10  * Copyright (c) 1980, 1988, 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: optr.c,v 1.14 2000/11/10 14:42:25 stelian Exp $";
45 #endif /* not lint */
46
47 #include <sys/param.h>
48 #include <sys/wait.h>
49 #include <sys/time.h>
50
51 #include <errno.h>
52 #include <fstab.h>
53 #include <grp.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <stdarg.h>
58 #include <unistd.h>
59 #include <utmp.h>
60 #include <sys/stat.h>
61
62 #ifdef __linux__
63 #include <linux/ext2_fs.h>
64 #include <ext2fs/ext2fs.h>
65 #include <bsdcompat.h>
66 #include <signal.h>
67 #endif
68
69 #include "dump.h"
70 #include "pathnames.h"
71 #include "bylabel.h"
72
73 static  void alarmcatch __P((int));
74 int     datesort __P((const void *, const void *));
75 static  void sendmes __P((const char *, const char *));
76
77 /* List of filesystem types that we can dump (same ext2 on-disk format) */
78 static char *fstypes[] = { "ext2", "ext3", "InterMezzo", NULL };
79
80 /*
81  *      Query the operator; This previously-fascist piece of code
82  *      no longer requires an exact response.
83  *      It is intended to protect dump aborting by inquisitive
84  *      people banging on the console terminal to see what is
85  *      happening which might cause dump to croak, destroying
86  *      a large number of hours of work.
87  *
88  *      Every 2 minutes we reprint the message, alerting others
89  *      that dump needs attention.
90  */
91 static  int timeout;
92 static  const char *attnmessage;                /* attention message */
93
94 int
95 query(const char *question)
96 {
97         char    replybuffer[64];
98         int     back, errcount;
99         FILE    *mytty;
100         time_t  firstprompt, when_answered;
101
102 #ifdef __linux__
103         (void)time4(&(firstprompt));
104 #else
105         (void)time((time_t *)&(firstprompt));
106 #endif
107
108         if ((mytty = fopen(_PATH_TTY, "r")) == NULL)
109                 quit("fopen on %s fails: %s\n", _PATH_TTY, strerror(errno));
110         attnmessage = question;
111         timeout = 0;
112         alarmcatch(0);
113         back = -1;
114         errcount = 0;
115         do {
116                 if (fgets(replybuffer, 63, mytty) == NULL) {
117                         clearerr(mytty);
118                         if (++errcount > 30)    /* XXX  ugly */
119                                 quit("excessive operator query failures\n");
120                 } else if (replybuffer[0] == 'y' || replybuffer[0] == 'Y') {
121                         back = 1;
122                 } else if (replybuffer[0] == 'n' || replybuffer[0] == 'N') {
123                         back = 0;
124                 } else {
125                         (void) fprintf(stderr,
126                             "  DUMP: \"Yes\" or \"No\"?\n");
127                         (void) fprintf(stderr,
128                             "  DUMP: %s: (\"yes\" or \"no\") ", question);
129                 }
130         } while (back < 0);
131
132         /*
133          *      Turn off the alarm, and reset the signal to trap out..
134          */
135         (void) alarm(0);
136         if (signal(SIGALRM, sig) == SIG_IGN)
137                 signal(SIGALRM, SIG_IGN);
138         (void) fclose(mytty);
139 #ifdef __linux__
140         (void)time4(&(when_answered));
141 #else
142         (void)time((time_t *)&(when_answered));
143 #endif
144         /*
145          * Adjust the base for time estimates to ignore time we spent waiting
146          * for operator input.
147          */
148         if ((tstart_writing != 0) && (when_answered != (time_t)-1) && (firstprompt != (time_t)-1))
149                 tstart_writing += (when_answered - firstprompt);
150         return(back);
151 }
152
153 char lastmsg[BUFSIZ];
154
155 /*
156  *      Alert the console operator, and enable the alarm clock to
157  *      sleep for 2 minutes in case nobody comes to satisfy dump
158  */
159 static void
160 alarmcatch(int signo)
161 {
162         int save_errno = errno;
163         if (notify == 0) {
164                 if (timeout == 0)
165                         (void) fprintf(stderr,
166                             "  DUMP: %s: (\"yes\" or \"no\") ",
167                             attnmessage);
168                 else
169                         msgtail("\7\7");
170         } else {
171                 if (timeout) {
172                         msgtail("\n");
173                         broadcast("");          /* just print last msg */
174                 }
175                 (void) fprintf(stderr,"  DUMP: %s: (\"yes\" or \"no\") ",
176                     attnmessage);
177         }
178         signal(SIGALRM, alarmcatch);
179         (void) alarm(120);
180         timeout = 1;
181         errno = save_errno;
182 }
183
184 /*
185  *      Here if an inquisitive operator interrupts the dump program
186  */
187 void
188 interrupt(int signo)
189 {
190         msg("Interrupt received.\n");
191         if (query("Do you want to abort dump?"))
192                 dumpabort(0);
193 }
194
195 /*
196  *      The following variables and routines manage alerting
197  *      operators to the status of dump.
198  *      This works much like wall(1) does.
199  */
200 struct  group *gp;
201
202 /*
203  *      Get the names from the group entry "operator" to notify.
204  */
205 void
206 set_operators(void)
207 {
208         if (!notify)            /*not going to notify*/
209                 return;
210         gp = getgrnam(OPGRENT);
211         (void) endgrent();
212         if (gp == NULL) {
213                 msg("No group entry for %s.\n", OPGRENT);
214                 notify = 0;
215                 return;
216         }
217 }
218
219 struct tm *localclock;
220
221 /*
222  *      We fork a child to do the actual broadcasting, so
223  *      that the process control groups are not messed up
224  */
225 void
226 broadcast(const char *message)
227 {
228         time_t          clock;
229         FILE    *f_utmp;
230         struct  utmp    utmp;
231         char    **np;
232         int     pid, s;
233
234         if (!notify || gp == NULL)
235                 return;
236
237         switch (pid = fork()) {
238         case -1:
239                 return;
240         case 0:
241                 break;
242         default:
243                 while (wait(&s) != pid)
244                         continue;
245                 return;
246         }
247
248         clock = time((time_t *)0);
249         localclock = localtime(&clock);
250
251         if ((f_utmp = fopen(_PATH_UTMP, "r")) == NULL) {
252                 msg("Cannot open %s: %s\n", _PATH_UTMP, strerror(errno));
253                 return;
254         }
255
256         while (!feof(f_utmp)) {
257                 if (fread((char *) &utmp, sizeof (struct utmp), 1, f_utmp) != 1)
258                         break;
259                 if (utmp.ut_name[0] == 0)
260                         continue;
261                 for (np = gp->gr_mem; *np; np++) {
262                         if (strncmp(*np, utmp.ut_name, sizeof(utmp.ut_name)) != 0)
263                                 continue;
264                         /*
265                          *      Do not send messages to operators on dialups
266                          */
267                         if (strncmp(utmp.ut_line, DIALUP, strlen(DIALUP)) == 0)
268                                 continue;
269 #ifdef DEBUG
270                         msg("Message to %s at %s\n", *np, utmp.ut_line);
271 #endif
272                         sendmes(utmp.ut_line, message);
273                 }
274         }
275         (void) fclose(f_utmp);
276         Exit(0);        /* the wait in this same routine will catch this */
277         /* NOTREACHED */
278 }
279
280 static void
281 sendmes(const char *tty, const char *message)
282 {
283         char t[MAXPATHLEN], buf[BUFSIZ];
284         register const char *cp;
285         int lmsg = 1;
286         FILE *f_tty;
287
288         (void) strcpy(t, _PATH_DEV);
289         (void) strncat(t, tty, sizeof t - strlen(_PATH_DEV) - 1);
290
291         if ((f_tty = fopen(t, "w")) != NULL) {
292                 setbuf(f_tty, buf);
293                 (void) fprintf(f_tty,
294                     "\n\
295 \7\7\7Message from the dump program to all operators at %d:%02d ...\r\n\n\
296 DUMP: NEEDS ATTENTION: ",
297                     localclock->tm_hour, localclock->tm_min);
298                 for (cp = lastmsg; ; cp++) {
299                         if (*cp == '\0') {
300                                 if (lmsg) {
301                                         cp = message;
302                                         if (!(cp && *cp != '\0'))
303                                                 break;
304                                         lmsg = 0;
305                                 } else
306                                         break;
307                         }
308                         if (*cp == '\n')
309                                 (void) putc('\r', f_tty);
310                         (void) putc(*cp, f_tty);
311                 }
312                 (void) fclose(f_tty);
313         }
314 }
315
316 /*
317  *      print out an estimate of the amount of time left to do the dump
318  */
319
320 time_t  tschedule = 0;
321
322 void
323 timeest(void)
324 {
325         time_t  tnow, deltat;
326
327 #ifdef __linux__
328         (void) time4(&tnow);
329 #else
330         (void) time((time_t *) &tnow);
331 #endif
332         if (tnow >= tschedule) {
333                 tschedule = tnow + 300;
334                 if (blockswritten < 500)
335                         return;
336                 if (blockswritten > tapesize)
337                         tapesize = blockswritten;
338                 deltat = tstart_writing - tnow +
339                         (1.0 * (tnow - tstart_writing))
340                         / blockswritten * tapesize;
341                 msg("%3.2f%% done, finished in %d:%02d\n",
342                         (blockswritten * 100.0) / tapesize,
343                         deltat / 3600, (deltat % 3600) / 60);
344         }
345 }
346
347 void
348 #ifdef __STDC__
349 msg(const char *fmt, ...)
350 #else
351 msg(fmt, va_alist)
352         char *fmt;
353         va_dcl
354 #endif
355 {
356         va_list ap;
357
358         (void) fprintf(stderr,"  DUMP: ");
359 #ifdef TDEBUG
360         (void) fprintf(stderr, "pid=%d ", getpid());
361 #endif
362 #ifdef __STDC__
363         va_start(ap, fmt);
364 #else
365         va_start(ap);
366 #endif
367         (void) vfprintf(stderr, fmt, ap);
368         va_end(ap);
369         (void) fflush(stdout);
370         (void) fflush(stderr);
371 #ifdef __STDC__
372         va_start(ap, fmt);
373 #else
374         va_start(ap);
375 #endif
376         (void) vsnprintf(lastmsg, sizeof(lastmsg), fmt, ap);
377         va_end(ap);
378 }
379
380 void
381 #ifdef __STDC__
382 msgtail(const char *fmt, ...)
383 #else
384 msgtail(fmt, va_alist)
385         char *fmt;
386         va_dcl
387 #endif
388 {
389         va_list ap;
390 #ifdef __STDC__
391         va_start(ap, fmt);
392 #else
393         va_start(ap);
394 #endif
395         (void) vfprintf(stderr, fmt, ap);
396         va_end(ap);
397 }
398
399 void
400 #ifdef __STDC__
401 quit(const char *fmt, ...)
402 #else
403 quit(fmt, va_alist)
404         char *fmt;
405         va_dcl
406 #endif
407 {
408         va_list ap;
409
410         (void) fprintf(stderr,"  DUMP: ");
411 #ifdef TDEBUG
412         (void) fprintf(stderr, "pid=%d ", getpid());
413 #endif
414 #ifdef __STDC__
415         va_start(ap, fmt);
416 #else
417         va_start(ap);
418 #endif
419         (void) vfprintf(stderr, fmt, ap);
420         va_end(ap);
421         (void) fflush(stdout);
422         (void) fflush(stderr);
423         dumpabort(0);
424 }
425
426 /*
427  *      Tell the operator what has to be done;
428  *      we don't actually do it
429  */
430
431 static struct fstab *
432 allocfsent(struct fstab *fs)
433 {
434         register struct fstab *new;
435
436         new = (struct fstab *)malloc(sizeof (*fs));
437         if (new == NULL)
438                 quit("%s\n", strerror(errno));
439         if (strlen(fs->fs_file) > 1 && fs->fs_file[strlen(fs->fs_file) - 1] == '/')
440                 fs->fs_file[strlen(fs->fs_file) - 1] = '\0';
441         if ((new->fs_file = strdup(fs->fs_file)) == NULL ||
442             (new->fs_type = strdup(fs->fs_type)) == NULL ||
443             (new->fs_vfstype = strdup(fs->fs_vfstype)) == NULL ||
444             (new->fs_spec = strdup(fs->fs_spec)) == NULL)
445                 quit("%s\n", strerror(errno));
446         new->fs_passno = fs->fs_passno;
447         new->fs_freq = fs->fs_freq;
448         return (new);
449 }
450
451 struct  pfstab {
452         struct  pfstab *pf_next;
453         struct  dumpdates *pf_dd;
454         struct  fstab *pf_fstab;
455 };
456
457 static  struct pfstab *table;
458
459 void
460 getfstab(void)
461 {
462         struct fstab *fs;
463         struct pfstab *pf;
464         struct pfstab *pfold = NULL;
465
466         if (setfsent() == 0) {
467                 msg("Can't open %s for dump table information: %s\n",
468                     _PATH_FSTAB, strerror(errno));
469                 return;
470         }
471         while ((fs = getfsent()) != NULL) {
472                 if (strcmp(fs->fs_type, FSTAB_RW) &&
473                     strcmp(fs->fs_type, FSTAB_RO) &&
474                     strcmp(fs->fs_type, FSTAB_RQ))
475                         continue;
476                 fs = allocfsent(fs);
477                 fs->fs_passno = 0;
478                 if ((pf = (struct pfstab *)malloc(sizeof (*pf))) == NULL)
479                         quit("%s\n", strerror(errno));
480                 pf->pf_fstab = fs;
481                 pf->pf_next = NULL;
482
483                 /* keep table in /etc/fstab order for use with -w and -W */
484                 if (pfold) {
485                         pfold->pf_next = pf;
486                         pfold = pf;
487                 } else
488                         pfold = table = pf;
489
490         }
491         (void) endfsent();
492 }
493
494 /*
495  * Search in the fstab for a file name.
496  * This file name can be either the special or the path file name.
497  *
498  * The entries in the fstab are the BLOCK special names, not the
499  * character special names.
500  * The caller of fstabsearch assures that the character device
501  * is dumped (that is much faster)
502  *
503  * The file name can omit the leading '/'.
504  */
505 struct fstab *
506 fstabsearch(const char *key)
507 {
508         register struct pfstab *pf;
509         register struct fstab *fs;
510         char *rn;
511
512         for (pf = table; pf != NULL; pf = pf->pf_next) {
513                 fs = pf->pf_fstab;
514                 if (strcmp(fs->fs_file, key) == 0 ||
515                     strcmp(fs->fs_spec, key) == 0)
516                         return (fs);
517                 rn = rawname(fs->fs_spec);
518                 if (rn != NULL && strcmp(rn, key) == 0)
519                         return (fs);
520                 if (key[0] != '/') {
521                         if (*fs->fs_spec == '/' &&
522                             strcmp(fs->fs_spec + 1, key) == 0)
523                                 return (fs);
524                         if (*fs->fs_file == '/' &&
525                             strcmp(fs->fs_file + 1, key) == 0)
526                                 return (fs);
527                 }
528         }
529         return (NULL);
530 }
531
532 #ifdef  __linux__
533 struct fstab *
534 fstabsearchdir(const char *key, char *directory)
535 {
536         register struct pfstab *pf;
537         register struct fstab *fs;
538         register struct fstab *found_fs = NULL;
539         unsigned int size = 0;
540         struct stat buf;
541
542         if (stat(key, &buf) == 0 && S_ISBLK(buf.st_mode))
543                 return NULL;
544
545         for (pf = table; pf != NULL; pf = pf->pf_next) {
546                 fs = pf->pf_fstab;
547                 if (strlen(fs->fs_file) > size &&
548                     strlen(key) > strlen(fs->fs_file) + 1 &&
549                     strncmp(fs->fs_file, key, strlen(fs->fs_file)) == 0 &&
550                     (key[strlen(fs->fs_file)] == '/' ||
551                      fs->fs_file[strlen(fs->fs_file) - 1] == '/')) {
552                         found_fs = fs;
553                         size = strlen(fs->fs_file);
554                 }
555         }
556         if (found_fs != NULL) {
557                 /*
558                  * Ok, we have found a fstab entry which matches the argument
559                  * We have to split the argument name into:
560                  * - a device name (from the fstab entry)
561                  * - a directory name on this device
562                  */
563                 strcpy(directory, key + size);
564         }
565         return(found_fs);
566 }
567 #endif
568
569 static void
570 print_wmsg(char arg, int dumpme, const char *dev, int level,
571            const char *mtpt, time_t ddate)
572 {
573         char *date;
574         
575         if (ddate)
576                 date = (char *)ctime(&ddate);
577         //date[16] = '\0';      /* blast away seconds and year */
578
579         if (!dumpme && arg == 'w')
580                 return;
581
582         (void) printf("%c %8s\t(%6s) Last dump: ",
583                       dumpme && (arg != 'w') ? '>' : ' ',
584                       dev,
585                       mtpt ? mtpt : "");
586
587         if (ddate)
588                 printf("Level %c, Date %s\n",
589                       level, date);
590         else
591                 printf("never\n");
592 }
593
594 /*
595  *      Tell the operator what to do
596  */
597 void
598 lastdump(char arg) /* w ==> just what to do; W ==> most recent dumps */
599 {
600         struct pfstab *pf;
601         time_t tnow;
602
603         (void) time(&tnow);
604         getfstab();             /* /etc/fstab input */
605         initdumptimes(0);       /* dumpdates input */
606         if (ddatev == NULL && table == NULL) {
607                 (void) printf("No %s or %s file found\n",
608                               _PATH_FSTAB, _PATH_DUMPDATES);
609                 return;
610         }
611
612         if (arg == 'w')
613                 (void) printf("Dump these file systems:\n");
614         else
615                 (void) printf("Last dump(s) done (Dump '>' file systems):\n");
616
617         if (ddatev != NULL) {
618                 struct dumpdates *dtwalk = NULL;
619                 int i;
620                 char *lastname;
621
622                 qsort((char *) ddatev, nddates, sizeof(struct dumpdates *), datesort);
623
624                 lastname = "??";
625                 ITITERATE(i, dtwalk) {
626                         struct fstab *dt;
627                         if (strncmp(lastname, dtwalk->dd_name,
628                                 sizeof(dtwalk->dd_name)) == 0)
629                                 continue;
630                         lastname = dtwalk->dd_name;
631                         if ((dt = dtwalk->dd_fstab) != NULL &&
632                             dt->fs_freq != 0) {
633                                 /* Overload fs_freq as dump level and
634                                  * fs_passno as date, because we can't
635                                  * change struct fstab format.
636                                  * A negative fs_freq means this
637                                  * filesystem needs to be dumped.
638                                  */
639                                 dt->fs_passno = dtwalk->dd_ddate;
640                                 if (dtwalk->dd_ddate <
641                                     tnow - (dt->fs_freq * 86400))
642                                         dt->fs_freq = -dtwalk->dd_level;
643                                 else
644                                         dt->fs_freq = dtwalk->dd_level;
645
646                         }
647                 }
648         }
649
650         /* print in /etc/fstab order only those filesystem types we can dump */
651         for (pf = table; pf != NULL; pf = pf->pf_next) {
652                 struct fstab *dt = pf->pf_fstab;
653                 char **type;
654
655                 for (type = fstypes; *type != NULL; type++) {
656                         if (strncmp(dt->fs_vfstype, *type,
657                                     sizeof(dt->fs_vfstype)) == 0) {
658                                 const char *disk = get_device_name(dt->fs_spec);
659                                 print_wmsg(arg, dt->fs_freq < 0 || !dt->fs_passno,
660                                            disk ? disk : dt->fs_spec,
661                                            dt->fs_freq < 0 ? -dt->fs_freq : dt->fs_freq, 
662                                            dt->fs_file,
663                                            dt->fs_passno);
664                         }
665                 }
666         }
667
668         /* print in /etc/dumpdates order if not in /etc/fstab */
669         if (ddatev != NULL) {
670                 struct dumpdates *dtwalk = NULL;
671                 char *lastname;
672                 int i;
673
674                 lastname = "??";
675                 ITITERATE(i, dtwalk) {
676                         if (strncmp(lastname, dtwalk->dd_name,
677                                 sizeof(dtwalk->dd_name)) == 0 ||
678                             dtwalk->dd_fstab != NULL)
679                                 continue;
680                         lastname = dtwalk->dd_name;
681                         print_wmsg(arg, 0, dtwalk->dd_name,
682                                    dtwalk->dd_level, NULL, dtwalk->dd_ddate);
683                 }
684         }
685 }
686
687 int
688 datesort(const void *a1, const void *a2)
689 {
690         struct dumpdates *d1 = *(struct dumpdates **)a1;
691         struct dumpdates *d2 = *(struct dumpdates **)a2;
692         int diff;
693
694         diff = strncmp(d1->dd_name, d2->dd_name, sizeof(d1->dd_name));
695         if (diff == 0)
696                 return (d2->dd_ddate - d1->dd_ddate);
697         return (diff);
698 }