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