2 * Copyright (c) 1998-2005 Sendmail, Inc. and its suppliers.
4 * Copyright (c) 1995-1997 Eric P. Allman. All rights reserved.
5 * Copyright (c) 1988, 1993
6 * The Regents of the University of California. All rights reserved.
8 * By using this file, you agree to the terms and conditions set
9 * forth in the LICENSE file which can be found at the top level of
10 * the sendmail distribution.
16 SM_RCSID("@(#)$Id: mci.c,v 8.221 2007/11/13 23:44:25 gshapiro Exp $")
18 #if NETINET || NETINET6
19 # include <arpa/inet.h>
20 #endif /* NETINET || NETINET6 */
24 static int mci_generate_persistent_path __P((const char *, char *,
26 static bool mci_load_persistent __P((MCI *));
27 static void mci_uncache __P((MCI **, bool));
28 static int mci_lock_host_statfile __P((MCI *));
29 static int mci_read_persistent __P((SM_FILE_T *, MCI *));
32 ** Mail Connection Information (MCI) Caching Module.
34 ** There are actually two separate things cached. The first is
35 ** the set of all open connections -- these are stored in a
36 ** (small) list. The second is stored in the symbol table; it
37 ** has the overall status for all hosts, whether or not there
38 ** is a connection open currently.
40 ** There should never be too many connections open (since this
41 ** could flood the socket table), nor should a connection be
42 ** allowed to sit idly for too long.
44 ** MaxMciCache is the maximum number of open connections that
47 ** MciCacheTimeout is the time (in seconds) that a connection
48 ** is permitted to survive without activity.
50 ** We actually try any cached connections by sending a RSET
51 ** before we use them; if the RSET fails we close down the
52 ** connection and reopen it (see smtpprobe()).
54 ** The persistent MCI code is donated by Mark Lovell and Paul
55 ** Vixie. It is based on the long term host status code in KJS
56 ** written by Paul but has been adapted by Mark to fit into the
60 static MCI **MciCache; /* the open connection cache */
63 ** MCI_CACHE -- enter a connection structure into the open connection cache
65 ** This may cause something else to be flushed.
68 ** mci -- the connection to cache.
78 register MCI **mcislot;
81 ** Find the best slot. This may cause expired connections
85 mcislot = mci_scan(mci);
88 /* we don't support caching */
92 if (mci->mci_host == NULL)
95 /* if this is already cached, we are done */
96 if (bitset(MCIF_CACHED, mci->mci_flags))
99 /* otherwise we may have to clear the slot */
100 if (*mcislot != NULL)
101 mci_uncache(mcislot, true);
104 sm_dprintf("mci_cache: caching %p (%s) in slot %d\n",
105 mci, mci->mci_host, (int) (mcislot - MciCache));
107 sm_syslog(LOG_DEBUG, CurEnv->e_id,
108 "mci_cache: caching %lx (%.100s) in slot %d",
109 (unsigned long) mci, mci->mci_host,
110 (int) (mcislot - MciCache));
113 mci->mci_flags |= MCIF_CACHED;
116 ** MCI_SCAN -- scan the cache, flush junk, and return best slot
119 ** savemci -- never flush this one. Can be null.
122 ** The LRU (or empty) slot.
130 register MCI **bestmci;
134 if (MaxMciCache <= 0)
136 /* we don't support caching */
140 if (MciCache == NULL)
143 MciCache = (MCI **) sm_pmalloc_x(MaxMciCache * sizeof(*MciCache));
144 memset((char *) MciCache, '\0', MaxMciCache * sizeof(*MciCache));
149 bestmci = &MciCache[0];
150 for (i = 0; i < MaxMciCache; i++)
153 if (mci == NULL || mci->mci_state == MCIS_CLOSED)
155 bestmci = &MciCache[i];
158 if ((mci->mci_lastuse + MciCacheTimeout <= now ||
159 (mci->mci_mailer != NULL &&
160 mci->mci_mailer->m_maxdeliveries > 0 &&
161 mci->mci_deliveries + 1 >= mci->mci_mailer->m_maxdeliveries))&&
164 /* connection idle too long or too many deliveries */
165 bestmci = &MciCache[i];
168 mci_uncache(bestmci, true);
171 if (*bestmci == NULL)
173 if (mci->mci_lastuse < (*bestmci)->mci_lastuse)
174 bestmci = &MciCache[i];
179 ** MCI_UNCACHE -- remove a connection from a slot.
181 ** May close a connection.
184 ** mcislot -- the slot to empty.
185 ** doquit -- if true, send QUIT protocol on this connection.
186 ** if false, we are assumed to be in a forked child;
187 ** all we want to do is close the file(s).
194 mci_uncache(mcislot, doquit)
195 register MCI **mcislot;
199 extern ENVELOPE BlankEnvelope;
205 if (mci->mci_host == NULL)
208 mci_unlock_host(mci);
211 sm_dprintf("mci_uncache: uncaching %p (%s) from slot %d (%d)\n",
212 mci, mci->mci_host, (int) (mcislot - MciCache),
215 sm_syslog(LOG_DEBUG, CurEnv->e_id,
216 "mci_uncache: uncaching %lx (%.100s) from slot %d (%d)",
217 (unsigned long) mci, mci->mci_host,
218 (int) (mcislot - MciCache), doquit);
220 mci->mci_deliveries = 0;
223 message("Closing connection to %s", mci->mci_host);
225 mci->mci_flags &= ~MCIF_CACHED;
227 /* only uses the envelope to flush the transcript file */
228 if (mci->mci_state != MCIS_CLOSED)
229 smtpquit(mci->mci_mailer, mci, &BlankEnvelope);
231 xla_host_end(mci->mci_host);
236 if (mci->mci_in != NULL)
237 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
238 if (mci->mci_out != NULL)
239 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
240 mci->mci_in = mci->mci_out = NULL;
241 mci->mci_state = MCIS_CLOSED;
242 mci->mci_exitstat = EX_OK;
246 mci->mci_retryrcpt = false;
247 mci->mci_tolist = NULL;
249 mci->mci_okrcpts = 0;
250 #endif /* PIPELINING */
253 SM_FREE_CLR(mci->mci_status);
254 SM_FREE_CLR(mci->mci_rstatus);
255 SM_FREE_CLR(mci->mci_heloname);
256 if (mci->mci_rpool != NULL)
258 sm_rpool_free(mci->mci_rpool);
259 mci->mci_macro.mac_rpool = NULL;
260 mci->mci_rpool = NULL;
264 ** MCI_FLUSH -- flush the entire cache
267 ** doquit -- if true, send QUIT protocol.
268 ** if false, just close the connection.
269 ** allbut -- but leave this one open.
276 mci_flush(doquit, allbut)
282 if (MciCache == NULL)
285 for (i = 0; i < MaxMciCache; i++)
287 if (allbut != MciCache[i])
288 mci_uncache(&MciCache[i], doquit);
292 ** MCI_GET -- get information about a particular host
295 ** host -- host to look for.
299 ** mci for this host (might be new).
309 extern SOCKADDR CurHostAddr;
311 /* clear CurHostAddr so we don't get a bogus address with this name */
312 memset(&CurHostAddr, '\0', sizeof(CurHostAddr));
314 /* clear out any expired connections */
315 (void) mci_scan(NULL);
318 syserr("!negative mno %d (%s)", m->m_mno, m->m_name);
320 s = stab(host, ST_MCI + m->m_mno, ST_ENTER);
323 /* initialize per-message data */
324 mci->mci_retryrcpt = false;
325 mci->mci_tolist = NULL;
327 mci->mci_okrcpts = 0;
328 #endif /* PIPELINING */
330 if (mci->mci_rpool == NULL)
331 mci->mci_rpool = sm_rpool_new_x(NULL);
333 if (mci->mci_macro.mac_rpool == NULL)
334 mci->mci_macro.mac_rpool = mci->mci_rpool;
337 ** We don't need to load the persistent data if we have data
338 ** already loaded in the cache.
341 if (mci->mci_host == NULL &&
342 (mci->mci_host = s->s_name) != NULL &&
343 !mci_load_persistent(mci))
346 sm_dprintf("mci_get(%s %s): lock failed\n",
348 mci->mci_exitstat = EX_TEMPFAIL;
349 mci->mci_state = MCIS_CLOSED;
350 mci->mci_statfile = NULL;
356 sm_dprintf("mci_get(%s %s): mci_state=%d, _flags=%lx, _exitstat=%d, _errno=%d\n",
357 host, m->m_name, mci->mci_state, mci->mci_flags,
358 mci->mci_exitstat, mci->mci_errno);
361 if (mci->mci_state == MCIS_OPEN)
363 /* poke the connection to see if it's still alive */
364 (void) smtpprobe(mci);
366 /* reset the stored state in the event of a timeout */
367 if (mci->mci_state != MCIS_OPEN)
370 mci->mci_exitstat = EX_OK;
371 mci->mci_state = MCIS_CLOSED;
375 /* get peer host address */
376 /* (this should really be in the mci struct) */
377 SOCKADDR_LEN_T socklen = sizeof(CurHostAddr);
379 (void) getpeername(sm_io_getinfo(mci->mci_in,
380 SM_IO_WHAT_FD, NULL),
381 (struct sockaddr *) &CurHostAddr, &socklen);
384 if (mci->mci_state == MCIS_CLOSED)
386 time_t now = curtime();
388 /* if this info is stale, ignore it */
389 if (mci->mci_lastuse + MciInfoTimeout <= now)
391 mci->mci_lastuse = now;
393 mci->mci_exitstat = EX_OK;
401 ** MCI_CLOSE -- (forcefully) close files used for a connection.
402 ** Note: this is a last resort, usually smtpquit() or endmailer()
403 ** should be used to close a connection.
406 ** mci -- the connection to close.
407 ** where -- where has this been called?
414 mci_close(mci, where)
423 if (mci->mci_out != NULL)
427 sm_dprintf("mci_close: mci_out!=NULL, where=%s\n",
429 mci_dump(sm_debug_file(), mci, false);
432 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
435 if (mci->mci_in != NULL)
439 sm_dprintf("mci_close: mci_in!=NULL, where=%s\n",
442 mci_dump(sm_debug_file(), mci, false);
444 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
447 mci->mci_state = MCIS_CLOSED;
451 ** MCI_NEW -- allocate new MCI structure
454 ** rpool -- if non-NULL: allocate from that rpool.
467 mci = (MCI *) sm_malloc_x(sizeof(*mci));
469 mci = (MCI *) sm_rpool_malloc_x(rpool, sizeof(*mci));
470 memset((char *) mci, '\0', sizeof(*mci));
471 mci->mci_rpool = sm_rpool_new_x(NULL);
472 mci->mci_macro.mac_rpool = mci->mci_rpool;
476 ** MCI_MATCH -- check connection cache for a particular host
479 ** host -- host to look for.
483 ** true iff open connection exists.
494 if (m->m_mno < 0 || m->m_mno > MAXMAILERS)
496 s = stab(host, ST_MCI + m->m_mno, ST_FIND);
501 return mci->mci_state == MCIS_OPEN;
504 ** MCI_SETSTAT -- set status codes in MCI structure.
507 ** mci -- the MCI structure to set.
508 ** xstat -- the exit status code.
509 ** dstat -- the DSN status code.
510 ** rstat -- the SMTP status code.
517 mci_setstat(mci, xstat, dstat, rstat)
523 /* protocol errors should never be interpreted as sticky */
524 if (xstat != EX_NOTSTICKY && xstat != EX_PROTOCOL)
525 mci->mci_exitstat = xstat;
527 SM_FREE_CLR(mci->mci_status);
529 mci->mci_status = sm_strdup_x(dstat);
531 SM_FREE_CLR(mci->mci_rstatus);
533 mci->mci_rstatus = sm_strdup_x(rstat);
536 ** MCI_DUMP -- dump the contents of an MCI structure.
539 ** fp -- output file pointer
540 ** mci -- the MCI structure to dump.
551 int mcif_bit; /* flag bit */
552 char *mcif_name; /* flag name */
554 static struct mcifbits MciFlags[] =
556 { MCIF_VALID, "VALID" },
557 { MCIF_CACHED, "CACHED" },
558 { MCIF_ESMTP, "ESMTP" },
559 { MCIF_EXPN, "EXPN" },
560 { MCIF_SIZE, "SIZE" },
561 { MCIF_8BITMIME, "8BITMIME" },
562 { MCIF_7BIT, "7BIT" },
563 { MCIF_INHEADER, "INHEADER" },
564 { MCIF_CVT8TO7, "CVT8TO7" },
566 { MCIF_8BITOK, "8BITOK" },
567 { MCIF_CVT7TO8, "CVT7TO8" },
568 { MCIF_INMIME, "INMIME" },
569 { MCIF_AUTH, "AUTH" },
570 { MCIF_AUTHACT, "AUTHACT" },
571 { MCIF_ENHSTAT, "ENHSTAT" },
572 { MCIF_PIPELINED, "PIPELINED" },
575 { MCIF_TLSACT, "TLSACT" },
576 #endif /* STARTTLS */
577 { MCIF_DLVR_BY, "DLVR_BY" },
582 mci_dump(fp, mci, logit)
591 sep = logit ? " " : "\n\t";
593 (void) sm_snprintf(p, SPACELEFT(buf, p), "MCI@%p: ", mci);
597 (void) sm_snprintf(p, SPACELEFT(buf, p), "NULL");
600 (void) sm_snprintf(p, SPACELEFT(buf, p), "flags=%lx", mci->mci_flags);
604 ** The following check is just for paranoia. It protects the
605 ** assignment in the if() clause. If there's not some minimum
606 ** amount of space we can stop right now. The check will not
607 ** trigger as long as sizeof(buf)=4000.
610 if (p >= buf + sizeof(buf) - 4)
612 if (mci->mci_flags != 0)
616 *p++ = '<'; /* protected above */
617 for (f = MciFlags; f->mcif_bit != 0; f++)
619 if (!bitset(f->mcif_bit, mci->mci_flags))
621 (void) sm_strlcpyn(p, SPACELEFT(buf, p), 2,
628 /* Note: sm_snprintf() takes care of NULL arguments for %s */
629 (void) sm_snprintf(p, SPACELEFT(buf, p),
630 ",%serrno=%d, herrno=%d, exitstat=%d, state=%d, pid=%d,%s",
631 sep, mci->mci_errno, mci->mci_herrno,
632 mci->mci_exitstat, mci->mci_state, (int) mci->mci_pid, sep);
634 (void) sm_snprintf(p, SPACELEFT(buf, p),
635 "maxsize=%ld, phase=%s, mailer=%s,%s",
636 mci->mci_maxsize, mci->mci_phase,
637 mci->mci_mailer == NULL ? "NULL" : mci->mci_mailer->m_name,
640 (void) sm_snprintf(p, SPACELEFT(buf, p),
641 "status=%s, rstatus=%s,%s",
642 mci->mci_status, mci->mci_rstatus, sep);
644 (void) sm_snprintf(p, SPACELEFT(buf, p),
645 "host=%s, lastuse=%s",
646 mci->mci_host, ctime(&mci->mci_lastuse));
649 sm_syslog(LOG_DEBUG, CurEnv->e_id, "%.1000s", buf);
651 (void) sm_io_fprintf(fp, SM_TIME_DEFAULT, "%s\n", buf);
654 ** MCI_DUMP_ALL -- print the entire MCI cache
657 ** fp -- output file pointer
658 ** logit -- if set, log the result instead of printing
666 mci_dump_all(fp, logit)
672 if (MciCache == NULL)
675 for (i = 0; i < MaxMciCache; i++)
676 mci_dump(fp, MciCache[i], logit);
679 ** MCI_LOCK_HOST -- Lock host while sending.
681 ** If we are contacting a host, we'll need to
682 ** update the status information in the host status
683 ** file, and if we want to do that, we ought to have
684 ** locked it. This has the (according to some)
685 ** desirable effect of serializing connectivity with
686 ** remote hosts -- i.e.: one connection to a given
690 ** mci -- containing the host we want to lock.
693 ** EX_OK -- got the lock.
694 ** EX_TEMPFAIL -- didn't get the lock.
704 sm_dprintf("mci_lock_host: NULL mci\n");
708 if (!SingleThreadDelivery)
711 return mci_lock_host_statfile(mci);
715 mci_lock_host_statfile(mci)
718 int save_errno = errno;
720 char fname[MAXPATHLEN];
722 if (HostStatDir == NULL || mci->mci_host == NULL)
726 sm_dprintf("mci_lock_host: attempting to lock %s\n",
729 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof(fname),
732 /* of course this should never happen */
734 sm_dprintf("mci_lock_host: Failed to generate host path for %s\n",
737 retVal = EX_TEMPFAIL;
741 mci->mci_statfile = safefopen(fname, O_RDWR, FileMode,
742 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH|SFF_CREAT);
744 if (mci->mci_statfile == NULL)
746 syserr("mci_lock_host: cannot create host lock file %s", fname);
750 if (!lockfile(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
751 fname, "", LOCK_EX|LOCK_NB))
754 sm_dprintf("mci_lock_host: couldn't get lock on %s\n",
756 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
757 mci->mci_statfile = NULL;
758 retVal = EX_TEMPFAIL;
762 if (tTd(56, 12) && mci->mci_statfile != NULL)
763 sm_dprintf("mci_lock_host: Sanity check -- lock is good\n");
770 ** MCI_UNLOCK_HOST -- unlock host
772 ** Clean up the lock on a host, close the file, let
773 ** someone else use it.
786 int save_errno = errno;
791 sm_dprintf("mci_unlock_host: NULL mci\n");
795 if (HostStatDir == NULL || mci->mci_host == NULL)
798 if (!SingleThreadDelivery && mci_lock_host_statfile(mci) == EX_TEMPFAIL)
801 sm_dprintf("mci_unlock_host: stat file already locked\n");
806 sm_dprintf("mci_unlock_host: store prior to unlock\n");
807 mci_store_persistent(mci);
810 if (mci->mci_statfile != NULL)
812 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
813 mci->mci_statfile = NULL;
819 ** MCI_LOAD_PERSISTENT -- load persistent host info
821 ** Load information about host that is kept
822 ** in common for all running sendmails.
825 ** mci -- the host/connection to load persistent info for.
828 ** true -- lock was successful
829 ** false -- lock failed
833 mci_load_persistent(mci)
836 int save_errno = errno;
839 char fname[MAXPATHLEN];
844 sm_dprintf("mci_load_persistent: NULL mci\n");
848 if (IgnoreHostStatus || HostStatDir == NULL || mci->mci_host == NULL)
851 /* Already have the persistent information in memory */
852 if (SingleThreadDelivery && mci->mci_statfile != NULL)
856 sm_dprintf("mci_load_persistent: Attempting to load persistent information for %s\n",
859 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof(fname),
862 /* Not much we can do if the file isn't there... */
864 sm_dprintf("mci_load_persistent: Couldn't generate host path\n");
868 fp = safefopen(fname, O_RDONLY, FileMode,
869 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
872 /* I can't think of any reason this should ever happen */
874 sm_dprintf("mci_load_persistent: open(%s): %s\n",
875 fname, sm_errstring(errno));
880 locked = lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname, "",
884 (void) mci_read_persistent(fp, mci);
885 (void) lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname,
889 (void) sm_io_close(fp, SM_TIME_DEFAULT);
896 ** MCI_READ_PERSISTENT -- read persistent host status file
899 ** fp -- the file pointer to read.
900 ** mci -- the pointer to fill in.
903 ** -1 -- if the file was corrupt.
907 ** This code makes the assumption that this data
908 ** will be read in an atomic fashion, and that the data
909 ** was written in an atomic fashion. Any other functioning
910 ** may lead to some form of insanity. This should be
911 ** perfectly safe due to underlying stdio buffering.
915 mci_read_persistent(fp, mci)
921 int saveLineNumber = LineNumber;
926 syserr("mci_read_persistent: NULL fp");
932 syserr("mci_read_persistent: NULL mci");
938 sm_dprintf("mci_read_persistent: fp=%lx, mci=",
942 SM_FREE_CLR(mci->mci_status);
943 SM_FREE_CLR(mci->mci_rstatus);
945 sm_io_rewind(fp, SM_TIME_DEFAULT);
948 while (sm_io_fgets(fp, SM_TIME_DEFAULT, buf, sizeof(buf)) != NULL)
951 p = strchr(buf, '\n');
956 case 'V': /* version stamp */
958 if (ver < 0 || ver > 0)
959 syserr("Unknown host status version %d: %d max",
963 case 'E': /* UNIX error number */
964 mci->mci_errno = atoi(&buf[1]);
967 case 'H': /* DNS error number */
968 mci->mci_herrno = atoi(&buf[1]);
971 case 'S': /* UNIX exit status */
972 mci->mci_exitstat = atoi(&buf[1]);
975 case 'D': /* DSN status */
976 mci->mci_status = newstr(&buf[1]);
979 case 'R': /* SMTP status */
980 mci->mci_rstatus = newstr(&buf[1]);
983 case 'U': /* last usage time */
984 mci->mci_lastuse = atol(&buf[1]);
987 case '.': /* end of file */
989 mci_dump(sm_debug_file(), mci, false);
993 sm_syslog(LOG_CRIT, NOQID,
994 "%s: line %d: Unknown host status line \"%s\"",
995 FileName == NULL ? mci->mci_host : FileName,
997 LineNumber = saveLineNumber;
1001 LineNumber = saveLineNumber;
1003 sm_dprintf("incomplete (missing dot for EOF)\n");
1009 ** MCI_STORE_PERSISTENT -- Store persistent MCI information
1011 ** Store information about host that is kept
1012 ** in common for all running sendmails.
1015 ** mci -- the host/connection to store persistent info for.
1022 mci_store_persistent(mci)
1025 int save_errno = errno;
1030 sm_dprintf("mci_store_persistent: NULL mci\n");
1034 if (HostStatDir == NULL || mci->mci_host == NULL)
1038 sm_dprintf("mci_store_persistent: Storing information for %s\n",
1041 if (mci->mci_statfile == NULL)
1044 sm_dprintf("mci_store_persistent: no statfile\n");
1048 sm_io_rewind(mci->mci_statfile, SM_TIME_DEFAULT);
1050 (void) ftruncate(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
1052 #endif /* !NOFTRUNCATE */
1054 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "V0\n");
1055 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "E%d\n",
1057 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "H%d\n",
1059 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "S%d\n",
1061 if (mci->mci_status != NULL)
1062 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1064 denlstring(mci->mci_status, true, false));
1065 if (mci->mci_rstatus != NULL)
1066 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1068 denlstring(mci->mci_rstatus, true, false));
1069 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "U%ld\n",
1070 (long)(mci->mci_lastuse));
1071 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, ".\n");
1073 (void) sm_io_flush(mci->mci_statfile, SM_TIME_DEFAULT);
1079 ** MCI_TRAVERSE_PERSISTENT -- walk persistent status tree
1081 ** Recursively find all the mci host files in `pathname'. Default to
1082 ** main host status directory if no path is provided.
1083 ** Call (*action)(pathname, host) for each file found.
1085 ** Note: all information is collected in a list before it is processed.
1086 ** This may not be the best way to do it, but it seems safest, since
1087 ** the file system would be touched while we are attempting to traverse
1088 ** the directory tree otherwise (during purges).
1091 ** action -- function to call on each node. If returns < 0,
1092 ** return immediately.
1093 ** pathname -- root of tree. If null, use main host status
1097 ** < 0 -- if any action routine returns a negative value, that
1098 ** value is returned.
1099 ** 0 -- if we successfully went to completion.
1100 ** > 0 -- return status from action()
1104 mci_traverse_persistent(action, pathname)
1105 int (*action)__P((char *, char *));
1108 struct stat statbuf;
1112 if (pathname == NULL)
1113 pathname = HostStatDir;
1114 if (pathname == NULL)
1118 sm_dprintf("mci_traverse: pathname is %s\n", pathname);
1120 ret = stat(pathname, &statbuf);
1124 sm_dprintf("mci_traverse: Failed to stat %s: %s\n",
1125 pathname, sm_errstring(errno));
1128 if (S_ISDIR(statbuf.st_mode))
1130 bool leftone, removedone;
1134 char newpath[MAXPATHLEN];
1135 #if MAXPATHLEN <= MAXNAMLEN - 3
1136 ERROR "MAXPATHLEN <= MAXNAMLEN - 3"
1137 #endif /* MAXPATHLEN <= MAXNAMLEN - 3 */
1139 if ((d = opendir(pathname)) == NULL)
1142 sm_dprintf("mci_traverse: opendir %s: %s\n",
1143 pathname, sm_errstring(errno));
1148 ** Reserve space for trailing '/', at least one
1149 ** character, and '\0'
1152 len = sizeof(newpath) - 3;
1153 if (sm_strlcpy(newpath, pathname, len) >= len)
1155 int save_errno = errno;
1158 sm_dprintf("mci_traverse: path \"%s\" too long",
1164 newptr = newpath + strlen(newpath);
1166 len = sizeof(newpath) - (newptr - newpath);
1169 ** repeat until no file has been removed
1170 ** this may become ugly when several files "expire"
1171 ** during these loops, but it's better than doing
1172 ** a rewinddir() inside the inner loop
1177 leftone = removedone = false;
1178 while ((e = readdir(d)) != NULL)
1180 if (e->d_name[0] == '.')
1183 if (sm_strlcpy(newptr, e->d_name, len) >= len)
1185 /* Skip truncated copies */
1189 sm_dprintf("mci_traverse: path \"%s%s\" too long",
1190 newpath, e->d_name);
1197 ret = mci_traverse_persistent(action, newpath);
1202 if (!removedone && ret == 0 &&
1203 action == mci_purge_persistent)
1210 ** The following appears to be
1211 ** necessary during purges, since
1212 ** we modify the directory structure
1218 sm_dprintf("mci_traverse: path %s: ret %d removed %d left %d\n",
1219 pathname, ret, removedone, leftone);
1220 } while (removedone);
1222 /* purge (or whatever) the directory proper */
1226 ret = (*action)(newpath, NULL);
1230 else if (S_ISREG(statbuf.st_mode))
1232 char *end = pathname + strlen(pathname) - 1;
1235 char host[MAXHOSTNAMELEN];
1236 char *hostptr = host;
1239 ** Reconstruct the host name from the path to the
1240 ** persistent information.
1245 if (hostptr != host)
1248 while (start > pathname && *(start - 1) != '/')
1254 for (scan = start; scan <= end; scan++)
1255 *(hostptr++) = *scan;
1258 } while (end > pathname && *end == '.');
1263 ** Do something with the file containing the persistent
1267 ret = (*action)(pathname, host);
1273 ** MCI_PRINT_PERSISTENT -- print persistent info
1275 ** Dump the persistent information in the file 'pathname'
1278 ** pathname -- the pathname to the status file.
1279 ** hostname -- the corresponding host name.
1286 mci_print_persistent(pathname, hostname)
1290 static bool initflag = false;
1292 int width = Verbose ? 78 : 25;
1296 /* skip directories */
1297 if (hostname == NULL)
1306 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1307 " -------------- Hostname --------------- How long ago ---------Results---------\n");
1310 fp = safefopen(pathname, O_RDONLY, FileMode,
1311 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
1316 sm_dprintf("mci_print_persistent: cannot open %s: %s\n",
1317 pathname, sm_errstring(errno));
1321 FileName = pathname;
1322 memset(&mcib, '\0', sizeof(mcib));
1323 if (mci_read_persistent(fp, &mcib) < 0)
1325 syserr("%s: could not read status file", pathname);
1326 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1331 locked = !lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), pathname,
1332 "", LOCK_SH|LOCK_NB);
1333 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1336 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%c%-39s %12s ",
1337 locked ? '*' : ' ', hostname,
1338 pintvl(curtime() - mcib.mci_lastuse, true));
1339 if (mcib.mci_rstatus != NULL)
1340 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n", width,
1342 else if (mcib.mci_exitstat == EX_TEMPFAIL && mcib.mci_errno != 0)
1343 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1344 "Deferred: %.*s\n", width - 10,
1345 sm_errstring(mcib.mci_errno));
1346 else if (mcib.mci_exitstat != 0)
1348 char *exmsg = sm_sysexmsg(mcib.mci_exitstat);
1354 (void) sm_snprintf(buf, sizeof(buf),
1355 "Unknown mailer error %d",
1357 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1361 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1364 else if (mcib.mci_errno == 0)
1365 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK\n");
1367 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK: %.*s\n",
1368 width - 4, sm_errstring(mcib.mci_errno));
1373 ** MCI_PURGE_PERSISTENT -- Remove a persistence status file.
1376 ** pathname -- path to the status file.
1377 ** hostname -- name of host corresponding to that file.
1378 ** NULL if this is a directory (domain).
1382 ** 1 -- file not deleted (too young, incorrect format)
1383 ** < 0 -- some error occurred
1387 mci_purge_persistent(pathname, hostname)
1391 struct stat statbuf;
1392 char *end = pathname + strlen(pathname) - 1;
1396 sm_dprintf("mci_purge_persistent: purging %s\n", pathname);
1398 ret = stat(pathname, &statbuf);
1402 sm_dprintf("mci_purge_persistent: Failed to stat %s: %s\n",
1403 pathname, sm_errstring(errno));
1406 if (curtime() - statbuf.st_mtime <= MciInfoTimeout)
1408 if (hostname != NULL)
1410 /* remove the file */
1411 ret = unlink(pathname);
1415 sm_syslog(LOG_ERR, NOQID,
1416 "mci_purge_persistent: failed to unlink %s: %s",
1417 pathname, sm_errstring(errno));
1419 sm_dprintf("mci_purge_persistent: failed to unlink %s: %s\n",
1420 pathname, sm_errstring(errno));
1426 /* remove the directory */
1431 sm_dprintf("mci_purge_persistent: dpurge %s\n", pathname);
1433 ret = rmdir(pathname);
1437 sm_dprintf("mci_purge_persistent: rmdir %s: %s\n",
1438 pathname, sm_errstring(errno));
1446 ** MCI_GENERATE_PERSISTENT_PATH -- generate path from hostname
1448 ** Given `host', convert from a.b.c to $HostStatDir/c./b./a,
1449 ** putting the result into `path'. if `createflag' is set, intervening
1450 ** directories will be created as needed.
1453 ** host -- host name to convert from.
1454 ** path -- place to store result.
1455 ** pathlen -- length of path buffer.
1456 ** createflag -- if set, create intervening directories as
1465 mci_generate_persistent_path(host, path, pathlen, createflag)
1471 char *elem, *p, *x, ch;
1474 char t_host[MAXHOSTNAMELEN];
1476 struct in6_addr in6_addr;
1477 #endif /* NETINET6 */
1480 ** Rationality check the arguments.
1485 syserr("mci_generate_persistent_path: null host");
1490 syserr("mci_generate_persistent_path: null path");
1495 sm_dprintf("mci_generate_persistent_path(%s): ", host);
1497 if (*host == '\0' || *host == '.')
1500 /* make certain this is not a bracketed host number */
1501 if (strlen(host) > sizeof(t_host) - 1)
1504 (void) sm_strlcpy(t_host, host + 1, sizeof(t_host));
1506 (void) sm_strlcpy(t_host, host, sizeof(t_host));
1509 ** Delete any trailing dots from the hostname.
1510 ** Leave 'elem' pointing at the \0.
1513 elem = t_host + strlen(t_host);
1514 while (elem > t_host &&
1515 (elem[-1] == '.' || (host[0] == '[' && elem[-1] == ']')))
1518 /* check for bogus bracketed address */
1523 if (anynet_pton(AF_INET6, t_host, &in6_addr) == 1)
1525 # endif /* NETINET6 */
1527 if (inet_addr(t_host) != INADDR_NONE)
1529 # endif /* NETINET */
1534 /* check for what will be the final length of the path */
1535 len = strlen(HostStatDir) + 2;
1536 for (p = (char *) t_host; *p != '\0'; p++)
1541 if (p[0] == '.' && p[1] == '.')
1544 if (len > pathlen || len < 1)
1546 (void) sm_strlcpy(path, HostStatDir, pathlen);
1547 p = path + strlen(path);
1548 while (elem > t_host)
1550 if (!path_is_dir(path, createflag))
1556 while (elem >= t_host && *elem != '.')
1560 while ((ch = *x++) != '\0' && ch != '.')
1562 if (isascii(ch) && isupper(ch))
1565 ch = ':'; /* / -> : */
1575 sm_dprintf("FAILURE %d\n", ret);
1577 sm_dprintf("SUCCESS %s\n", path);