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.214 2005/02/04 22:01:45 ca 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 NOOP
51 ** before we use them; if the NOOP fails we close down the
52 ** connection and reopen it. Note that this means that a
53 ** server SMTP that doesn't support NOOP will hose the
54 ** algorithm -- but that doesn't seem too likely.
56 ** The persistent MCI code is donated by Mark Lovell and Paul
57 ** Vixie. It is based on the long term host status code in KJS
58 ** written by Paul but has been adapted by Mark to fit into the
62 static MCI **MciCache; /* the open connection cache */
65 ** MCI_CACHE -- enter a connection structure into the open connection cache
67 ** This may cause something else to be flushed.
70 ** mci -- the connection to cache.
80 register MCI **mcislot;
83 ** Find the best slot. This may cause expired connections
87 mcislot = mci_scan(mci);
90 /* we don't support caching */
94 if (mci->mci_host == NULL)
97 /* if this is already cached, we are done */
98 if (bitset(MCIF_CACHED, mci->mci_flags))
101 /* otherwise we may have to clear the slot */
102 if (*mcislot != NULL)
103 mci_uncache(mcislot, true);
106 sm_dprintf("mci_cache: caching %p (%s) in slot %d\n",
107 mci, mci->mci_host, (int) (mcislot - MciCache));
109 sm_syslog(LOG_DEBUG, CurEnv->e_id,
110 "mci_cache: caching %lx (%.100s) in slot %d",
111 (unsigned long) mci, mci->mci_host,
112 (int) (mcislot - MciCache));
115 mci->mci_flags |= MCIF_CACHED;
118 ** MCI_SCAN -- scan the cache, flush junk, and return best slot
121 ** savemci -- never flush this one. Can be null.
124 ** The LRU (or empty) slot.
132 register MCI **bestmci;
136 if (MaxMciCache <= 0)
138 /* we don't support caching */
142 if (MciCache == NULL)
145 MciCache = (MCI **) sm_pmalloc_x(MaxMciCache * sizeof *MciCache);
146 memset((char *) MciCache, '\0', MaxMciCache * sizeof *MciCache);
151 bestmci = &MciCache[0];
152 for (i = 0; i < MaxMciCache; i++)
155 if (mci == NULL || mci->mci_state == MCIS_CLOSED)
157 bestmci = &MciCache[i];
160 if ((mci->mci_lastuse + MciCacheTimeout <= now ||
161 (mci->mci_mailer != NULL &&
162 mci->mci_mailer->m_maxdeliveries > 0 &&
163 mci->mci_deliveries + 1 >= mci->mci_mailer->m_maxdeliveries))&&
166 /* connection idle too long or too many deliveries */
167 bestmci = &MciCache[i];
170 mci_uncache(bestmci, true);
173 if (*bestmci == NULL)
175 if (mci->mci_lastuse < (*bestmci)->mci_lastuse)
176 bestmci = &MciCache[i];
181 ** MCI_UNCACHE -- remove a connection from a slot.
183 ** May close a connection.
186 ** mcislot -- the slot to empty.
187 ** doquit -- if true, send QUIT protocol on this connection.
188 ** if false, we are assumed to be in a forked child;
189 ** all we want to do is close the file(s).
196 mci_uncache(mcislot, doquit)
197 register MCI **mcislot;
201 extern ENVELOPE BlankEnvelope;
207 if (mci->mci_host == NULL)
210 mci_unlock_host(mci);
213 sm_dprintf("mci_uncache: uncaching %p (%s) from slot %d (%d)\n",
214 mci, mci->mci_host, (int) (mcislot - MciCache),
217 sm_syslog(LOG_DEBUG, CurEnv->e_id,
218 "mci_uncache: uncaching %lx (%.100s) from slot %d (%d)",
219 (unsigned long) mci, mci->mci_host,
220 (int) (mcislot - MciCache), doquit);
222 mci->mci_deliveries = 0;
225 message("Closing connection to %s", mci->mci_host);
227 mci->mci_flags &= ~MCIF_CACHED;
229 /* only uses the envelope to flush the transcript file */
230 if (mci->mci_state != MCIS_CLOSED)
231 smtpquit(mci->mci_mailer, mci, &BlankEnvelope);
233 xla_host_end(mci->mci_host);
238 if (mci->mci_in != NULL)
239 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
240 if (mci->mci_out != NULL)
241 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
242 mci->mci_in = mci->mci_out = NULL;
243 mci->mci_state = MCIS_CLOSED;
244 mci->mci_exitstat = EX_OK;
248 mci->mci_retryrcpt = false;
249 mci->mci_tolist = NULL;
251 mci->mci_okrcpts = 0;
252 #endif /* PIPELINING */
255 SM_FREE_CLR(mci->mci_status);
256 SM_FREE_CLR(mci->mci_rstatus);
257 SM_FREE_CLR(mci->mci_heloname);
258 if (mci->mci_rpool != NULL)
260 sm_rpool_free(mci->mci_rpool);
261 mci->mci_macro.mac_rpool = NULL;
262 mci->mci_rpool = NULL;
266 ** MCI_FLUSH -- flush the entire cache
269 ** doquit -- if true, send QUIT protocol.
270 ** if false, just close the connection.
271 ** allbut -- but leave this one open.
278 mci_flush(doquit, allbut)
284 if (MciCache == NULL)
287 for (i = 0; i < MaxMciCache; i++)
289 if (allbut != MciCache[i])
290 mci_uncache(&MciCache[i], doquit);
294 ** MCI_GET -- get information about a particular host
297 ** host -- host to look for.
301 ** mci for this host (might be new).
311 extern SOCKADDR CurHostAddr;
313 /* clear CurHostAddr so we don't get a bogus address with this name */
314 memset(&CurHostAddr, '\0', sizeof CurHostAddr);
316 /* clear out any expired connections */
317 (void) mci_scan(NULL);
320 syserr("!negative mno %d (%s)", m->m_mno, m->m_name);
322 s = stab(host, ST_MCI + m->m_mno, ST_ENTER);
325 /* initialize per-message data */
326 mci->mci_retryrcpt = false;
327 mci->mci_tolist = NULL;
329 mci->mci_okrcpts = 0;
330 #endif /* PIPELINING */
332 if (mci->mci_rpool == NULL)
333 mci->mci_rpool = sm_rpool_new_x(NULL);
335 if (mci->mci_macro.mac_rpool == NULL)
336 mci->mci_macro.mac_rpool = mci->mci_rpool;
339 ** We don't need to load the persistent data if we have data
340 ** already loaded in the cache.
343 if (mci->mci_host == NULL &&
344 (mci->mci_host = s->s_name) != NULL &&
345 !mci_load_persistent(mci))
348 sm_dprintf("mci_get(%s %s): lock failed\n",
350 mci->mci_exitstat = EX_TEMPFAIL;
351 mci->mci_state = MCIS_CLOSED;
352 mci->mci_statfile = NULL;
358 sm_dprintf("mci_get(%s %s): mci_state=%d, _flags=%lx, _exitstat=%d, _errno=%d\n",
359 host, m->m_name, mci->mci_state, mci->mci_flags,
360 mci->mci_exitstat, mci->mci_errno);
363 if (mci->mci_state == MCIS_OPEN)
365 /* poke the connection to see if it's still alive */
366 (void) smtpprobe(mci);
368 /* reset the stored state in the event of a timeout */
369 if (mci->mci_state != MCIS_OPEN)
372 mci->mci_exitstat = EX_OK;
373 mci->mci_state = MCIS_CLOSED;
377 /* get peer host address */
378 /* (this should really be in the mci struct) */
379 SOCKADDR_LEN_T socklen = sizeof CurHostAddr;
381 (void) getpeername(sm_io_getinfo(mci->mci_in,
382 SM_IO_WHAT_FD, NULL),
383 (struct sockaddr *) &CurHostAddr, &socklen);
386 if (mci->mci_state == MCIS_CLOSED)
388 time_t now = curtime();
390 /* if this info is stale, ignore it */
391 if (mci->mci_lastuse + MciInfoTimeout <= now)
393 mci->mci_lastuse = now;
395 mci->mci_exitstat = EX_OK;
403 ** MCI_CLOSE -- (forcefully) close files used for a connection.
404 ** Note: this is a last resort, usually smtpquit() or endmailer()
405 ** should be used to close a connection.
408 ** mci -- the connection to close.
409 ** where -- where has this been called?
416 mci_close(mci, where)
425 if (mci->mci_out != NULL)
429 sm_dprintf("mci_close: mci_out!=NULL, where=%s\n",
431 mci_dump(sm_debug_file(), mci, false);
434 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
437 if (mci->mci_in != NULL)
441 sm_dprintf("mci_close: mci_in!=NULL, where=%s\n",
444 mci_dump(sm_debug_file(), mci, false);
446 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
449 mci->mci_state = MCIS_CLOSED;
453 ** MCI_NEW -- allocate new MCI structure
456 ** rpool -- if non-NULL: allocate from that rpool.
469 mci = (MCI *) sm_malloc_x(sizeof *mci);
471 mci = (MCI *) sm_rpool_malloc_x(rpool, sizeof *mci);
472 memset((char *) mci, '\0', sizeof *mci);
473 mci->mci_rpool = sm_rpool_new_x(NULL);
474 mci->mci_macro.mac_rpool = mci->mci_rpool;
478 ** MCI_MATCH -- check connection cache for a particular host
481 ** host -- host to look for.
485 ** true iff open connection exists.
496 if (m->m_mno < 0 || m->m_mno > MAXMAILERS)
498 s = stab(host, ST_MCI + m->m_mno, ST_FIND);
503 return mci->mci_state == MCIS_OPEN;
506 ** MCI_SETSTAT -- set status codes in MCI structure.
509 ** mci -- the MCI structure to set.
510 ** xstat -- the exit status code.
511 ** dstat -- the DSN status code.
512 ** rstat -- the SMTP status code.
519 mci_setstat(mci, xstat, dstat, rstat)
525 /* protocol errors should never be interpreted as sticky */
526 if (xstat != EX_NOTSTICKY && xstat != EX_PROTOCOL)
527 mci->mci_exitstat = xstat;
529 SM_FREE_CLR(mci->mci_status);
531 mci->mci_status = sm_strdup_x(dstat);
533 SM_FREE_CLR(mci->mci_rstatus);
535 mci->mci_rstatus = sm_strdup_x(rstat);
538 ** MCI_DUMP -- dump the contents of an MCI structure.
541 ** fp -- output file pointer
542 ** mci -- the MCI structure to dump.
553 int mcif_bit; /* flag bit */
554 char *mcif_name; /* flag name */
556 static struct mcifbits MciFlags[] =
558 { MCIF_VALID, "VALID" },
559 { MCIF_CACHED, "CACHED" },
560 { MCIF_ESMTP, "ESMTP" },
561 { MCIF_EXPN, "EXPN" },
562 { MCIF_SIZE, "SIZE" },
563 { MCIF_8BITMIME, "8BITMIME" },
564 { MCIF_7BIT, "7BIT" },
565 { MCIF_INHEADER, "INHEADER" },
566 { MCIF_CVT8TO7, "CVT8TO7" },
568 { MCIF_8BITOK, "8BITOK" },
569 { MCIF_CVT7TO8, "CVT7TO8" },
570 { MCIF_INMIME, "INMIME" },
571 { MCIF_AUTH, "AUTH" },
572 { MCIF_AUTHACT, "AUTHACT" },
573 { MCIF_ENHSTAT, "ENHSTAT" },
574 { MCIF_PIPELINED, "PIPELINED" },
577 { MCIF_TLSACT, "TLSACT" },
578 #endif /* STARTTLS */
579 { MCIF_DLVR_BY, "DLVR_BY" },
584 mci_dump(fp, mci, logit)
593 sep = logit ? " " : "\n\t";
595 (void) sm_snprintf(p, SPACELEFT(buf, p), "MCI@%p: ", mci);
599 (void) sm_snprintf(p, SPACELEFT(buf, p), "NULL");
602 (void) sm_snprintf(p, SPACELEFT(buf, p), "flags=%lx", mci->mci_flags);
606 ** The following check is just for paranoia. It protects the
607 ** assignment in the if() clause. If there's not some minimum
608 ** amount of space we can stop right now. The check will not
609 ** trigger as long as sizeof(buf)=4000.
612 if (p >= buf + sizeof(buf) - 4)
614 if (mci->mci_flags != 0)
618 *p++ = '<'; /* protected above */
619 for (f = MciFlags; f->mcif_bit != 0; f++)
621 if (!bitset(f->mcif_bit, mci->mci_flags))
623 (void) sm_strlcpyn(p, SPACELEFT(buf, p), 2,
630 /* Note: sm_snprintf() takes care of NULL arguments for %s */
631 (void) sm_snprintf(p, SPACELEFT(buf, p),
632 ",%serrno=%d, herrno=%d, exitstat=%d, state=%d, pid=%d,%s",
633 sep, mci->mci_errno, mci->mci_herrno,
634 mci->mci_exitstat, mci->mci_state, (int) mci->mci_pid, sep);
636 (void) sm_snprintf(p, SPACELEFT(buf, p),
637 "maxsize=%ld, phase=%s, mailer=%s,%s",
638 mci->mci_maxsize, mci->mci_phase,
639 mci->mci_mailer == NULL ? "NULL" : mci->mci_mailer->m_name,
642 (void) sm_snprintf(p, SPACELEFT(buf, p),
643 "status=%s, rstatus=%s,%s",
644 mci->mci_status, mci->mci_rstatus, sep);
646 (void) sm_snprintf(p, SPACELEFT(buf, p),
647 "host=%s, lastuse=%s",
648 mci->mci_host, ctime(&mci->mci_lastuse));
651 sm_syslog(LOG_DEBUG, CurEnv->e_id, "%.1000s", buf);
653 (void) sm_io_fprintf(fp, SM_TIME_DEFAULT, "%s\n", buf);
656 ** MCI_DUMP_ALL -- print the entire MCI cache
659 ** fp -- output file pointer
660 ** logit -- if set, log the result instead of printing
668 mci_dump_all(fp, logit)
674 if (MciCache == NULL)
677 for (i = 0; i < MaxMciCache; i++)
678 mci_dump(fp, MciCache[i], logit);
681 ** MCI_LOCK_HOST -- Lock host while sending.
683 ** If we are contacting a host, we'll need to
684 ** update the status information in the host status
685 ** file, and if we want to do that, we ought to have
686 ** locked it. This has the (according to some)
687 ** desirable effect of serializing connectivity with
688 ** remote hosts -- i.e.: one connection to a given
692 ** mci -- containing the host we want to lock.
695 ** EX_OK -- got the lock.
696 ** EX_TEMPFAIL -- didn't get the lock.
706 sm_dprintf("mci_lock_host: NULL mci\n");
710 if (!SingleThreadDelivery)
713 return mci_lock_host_statfile(mci);
717 mci_lock_host_statfile(mci)
720 int save_errno = errno;
722 char fname[MAXPATHLEN];
724 if (HostStatDir == NULL || mci->mci_host == NULL)
728 sm_dprintf("mci_lock_host: attempting to lock %s\n",
731 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof fname,
734 /* of course this should never happen */
736 sm_dprintf("mci_lock_host: Failed to generate host path for %s\n",
739 retVal = EX_TEMPFAIL;
743 mci->mci_statfile = safefopen(fname, O_RDWR, FileMode,
744 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH|SFF_CREAT);
746 if (mci->mci_statfile == NULL)
748 syserr("mci_lock_host: cannot create host lock file %s", fname);
752 if (!lockfile(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
753 fname, "", LOCK_EX|LOCK_NB))
756 sm_dprintf("mci_lock_host: couldn't get lock on %s\n",
758 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
759 mci->mci_statfile = NULL;
760 retVal = EX_TEMPFAIL;
764 if (tTd(56, 12) && mci->mci_statfile != NULL)
765 sm_dprintf("mci_lock_host: Sanity check -- lock is good\n");
772 ** MCI_UNLOCK_HOST -- unlock host
774 ** Clean up the lock on a host, close the file, let
775 ** someone else use it.
788 int save_errno = errno;
793 sm_dprintf("mci_unlock_host: NULL mci\n");
797 if (HostStatDir == NULL || mci->mci_host == NULL)
800 if (!SingleThreadDelivery && mci_lock_host_statfile(mci) == EX_TEMPFAIL)
803 sm_dprintf("mci_unlock_host: stat file already locked\n");
808 sm_dprintf("mci_unlock_host: store prior to unlock\n");
809 mci_store_persistent(mci);
812 if (mci->mci_statfile != NULL)
814 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
815 mci->mci_statfile = NULL;
821 ** MCI_LOAD_PERSISTENT -- load persistent host info
823 ** Load information about host that is kept
824 ** in common for all running sendmails.
827 ** mci -- the host/connection to load persistent info for.
830 ** true -- lock was successful
831 ** false -- lock failed
835 mci_load_persistent(mci)
838 int save_errno = errno;
841 char fname[MAXPATHLEN];
846 sm_dprintf("mci_load_persistent: NULL mci\n");
850 if (IgnoreHostStatus || HostStatDir == NULL || mci->mci_host == NULL)
853 /* Already have the persistent information in memory */
854 if (SingleThreadDelivery && mci->mci_statfile != NULL)
858 sm_dprintf("mci_load_persistent: Attempting to load persistent information for %s\n",
861 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof fname,
864 /* Not much we can do if the file isn't there... */
866 sm_dprintf("mci_load_persistent: Couldn't generate host path\n");
870 fp = safefopen(fname, O_RDONLY, FileMode,
871 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
874 /* I can't think of any reason this should ever happen */
876 sm_dprintf("mci_load_persistent: open(%s): %s\n",
877 fname, sm_errstring(errno));
882 locked = lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname, "",
886 (void) mci_read_persistent(fp, mci);
887 (void) lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname,
891 (void) sm_io_close(fp, SM_TIME_DEFAULT);
898 ** MCI_READ_PERSISTENT -- read persistent host status file
901 ** fp -- the file pointer to read.
902 ** mci -- the pointer to fill in.
905 ** -1 -- if the file was corrupt.
909 ** This code makes the assumption that this data
910 ** will be read in an atomic fashion, and that the data
911 ** was written in an atomic fashion. Any other functioning
912 ** may lead to some form of insanity. This should be
913 ** perfectly safe due to underlying stdio buffering.
917 mci_read_persistent(fp, mci)
923 int saveLineNumber = LineNumber;
927 syserr("mci_read_persistent: NULL fp");
929 syserr("mci_read_persistent: NULL mci");
932 sm_dprintf("mci_read_persistent: fp=%lx, mci=",
936 SM_FREE_CLR(mci->mci_status);
937 SM_FREE_CLR(mci->mci_rstatus);
939 sm_io_rewind(fp, SM_TIME_DEFAULT);
942 while (sm_io_fgets(fp, SM_TIME_DEFAULT, buf, sizeof buf) != NULL)
945 p = strchr(buf, '\n');
950 case 'V': /* version stamp */
952 if (ver < 0 || ver > 0)
953 syserr("Unknown host status version %d: %d max",
957 case 'E': /* UNIX error number */
958 mci->mci_errno = atoi(&buf[1]);
961 case 'H': /* DNS error number */
962 mci->mci_herrno = atoi(&buf[1]);
965 case 'S': /* UNIX exit status */
966 mci->mci_exitstat = atoi(&buf[1]);
969 case 'D': /* DSN status */
970 mci->mci_status = newstr(&buf[1]);
973 case 'R': /* SMTP status */
974 mci->mci_rstatus = newstr(&buf[1]);
977 case 'U': /* last usage time */
978 mci->mci_lastuse = atol(&buf[1]);
981 case '.': /* end of file */
983 mci_dump(sm_debug_file(), mci, false);
987 sm_syslog(LOG_CRIT, NOQID,
988 "%s: line %d: Unknown host status line \"%s\"",
989 FileName == NULL ? mci->mci_host : FileName,
991 LineNumber = saveLineNumber;
995 LineNumber = saveLineNumber;
997 sm_dprintf("incomplete (missing dot for EOF)\n");
1003 ** MCI_STORE_PERSISTENT -- Store persistent MCI information
1005 ** Store information about host that is kept
1006 ** in common for all running sendmails.
1009 ** mci -- the host/connection to store persistent info for.
1016 mci_store_persistent(mci)
1019 int save_errno = errno;
1024 sm_dprintf("mci_store_persistent: NULL mci\n");
1028 if (HostStatDir == NULL || mci->mci_host == NULL)
1032 sm_dprintf("mci_store_persistent: Storing information for %s\n",
1035 if (mci->mci_statfile == NULL)
1038 sm_dprintf("mci_store_persistent: no statfile\n");
1042 sm_io_rewind(mci->mci_statfile, SM_TIME_DEFAULT);
1044 (void) ftruncate(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
1046 #endif /* !NOFTRUNCATE */
1048 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "V0\n");
1049 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "E%d\n",
1051 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "H%d\n",
1053 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "S%d\n",
1055 if (mci->mci_status != NULL)
1056 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1058 denlstring(mci->mci_status, true, false));
1059 if (mci->mci_rstatus != NULL)
1060 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1062 denlstring(mci->mci_rstatus, true, false));
1063 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "U%ld\n",
1064 (long)(mci->mci_lastuse));
1065 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, ".\n");
1067 (void) sm_io_flush(mci->mci_statfile, SM_TIME_DEFAULT);
1073 ** MCI_TRAVERSE_PERSISTENT -- walk persistent status tree
1075 ** Recursively find all the mci host files in `pathname'. Default to
1076 ** main host status directory if no path is provided.
1077 ** Call (*action)(pathname, host) for each file found.
1079 ** Note: all information is collected in a list before it is processed.
1080 ** This may not be the best way to do it, but it seems safest, since
1081 ** the file system would be touched while we are attempting to traverse
1082 ** the directory tree otherwise (during purges).
1085 ** action -- function to call on each node. If returns < 0,
1086 ** return immediately.
1087 ** pathname -- root of tree. If null, use main host status
1091 ** < 0 -- if any action routine returns a negative value, that
1092 ** value is returned.
1093 ** 0 -- if we successfully went to completion.
1094 ** > 0 -- return status from action()
1098 mci_traverse_persistent(action, pathname)
1099 int (*action)__P((char *, char *));
1102 struct stat statbuf;
1106 if (pathname == NULL)
1107 pathname = HostStatDir;
1108 if (pathname == NULL)
1112 sm_dprintf("mci_traverse: pathname is %s\n", pathname);
1114 ret = stat(pathname, &statbuf);
1118 sm_dprintf("mci_traverse: Failed to stat %s: %s\n",
1119 pathname, sm_errstring(errno));
1122 if (S_ISDIR(statbuf.st_mode))
1124 bool leftone, removedone;
1128 char newpath[MAXPATHLEN];
1130 if ((d = opendir(pathname)) == NULL)
1133 sm_dprintf("mci_traverse: opendir %s: %s\n",
1134 pathname, sm_errstring(errno));
1137 len = sizeof(newpath) - MAXNAMLEN - 3;
1138 if (sm_strlcpy(newpath, pathname, len) >= len)
1141 sm_dprintf("mci_traverse: path \"%s\" too long",
1145 newptr = newpath + strlen(newpath);
1149 ** repeat until no file has been removed
1150 ** this may become ugly when several files "expire"
1151 ** during these loops, but it's better than doing
1152 ** a rewinddir() inside the inner loop
1157 leftone = removedone = false;
1158 while ((e = readdir(d)) != NULL)
1160 if (e->d_name[0] == '.')
1163 (void) sm_strlcpy(newptr, e->d_name,
1165 (newptr - newpath));
1169 ret = mci_traverse_persistent(action, newpath);
1174 if (!removedone && ret == 0 &&
1175 action == mci_purge_persistent)
1182 ** The following appears to be
1183 ** necessary during purges, since
1184 ** we modify the directory structure
1190 sm_dprintf("mci_traverse: path %s: ret %d removed %d left %d\n",
1191 pathname, ret, removedone, leftone);
1192 } while (removedone);
1194 /* purge (or whatever) the directory proper */
1198 ret = (*action)(newpath, NULL);
1202 else if (S_ISREG(statbuf.st_mode))
1204 char *end = pathname + strlen(pathname) - 1;
1207 char host[MAXHOSTNAMELEN];
1208 char *hostptr = host;
1211 ** Reconstruct the host name from the path to the
1212 ** persistent information.
1217 if (hostptr != host)
1220 while (start > pathname && *(start - 1) != '/')
1226 for (scan = start; scan <= end; scan++)
1227 *(hostptr++) = *scan;
1230 } while (end > pathname && *end == '.');
1235 ** Do something with the file containing the persistent
1239 ret = (*action)(pathname, host);
1245 ** MCI_PRINT_PERSISTENT -- print persistent info
1247 ** Dump the persistent information in the file 'pathname'
1250 ** pathname -- the pathname to the status file.
1251 ** hostname -- the corresponding host name.
1258 mci_print_persistent(pathname, hostname)
1262 static bool initflag = false;
1264 int width = Verbose ? 78 : 25;
1268 /* skip directories */
1269 if (hostname == NULL)
1278 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1279 " -------------- Hostname --------------- How long ago ---------Results---------\n");
1282 fp = safefopen(pathname, O_RDONLY, FileMode,
1283 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
1288 sm_dprintf("mci_print_persistent: cannot open %s: %s\n",
1289 pathname, sm_errstring(errno));
1293 FileName = pathname;
1294 memset(&mcib, '\0', sizeof mcib);
1295 if (mci_read_persistent(fp, &mcib) < 0)
1297 syserr("%s: could not read status file", pathname);
1298 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1303 locked = !lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), pathname,
1304 "", LOCK_SH|LOCK_NB);
1305 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1308 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%c%-39s %12s ",
1309 locked ? '*' : ' ', hostname,
1310 pintvl(curtime() - mcib.mci_lastuse, true));
1311 if (mcib.mci_rstatus != NULL)
1312 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n", width,
1314 else if (mcib.mci_exitstat == EX_TEMPFAIL && mcib.mci_errno != 0)
1315 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1316 "Deferred: %.*s\n", width - 10,
1317 sm_errstring(mcib.mci_errno));
1318 else if (mcib.mci_exitstat != 0)
1320 char *exmsg = sm_sysexmsg(mcib.mci_exitstat);
1326 (void) sm_snprintf(buf, sizeof buf,
1327 "Unknown mailer error %d",
1329 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1333 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1336 else if (mcib.mci_errno == 0)
1337 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK\n");
1339 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK: %.*s\n",
1340 width - 4, sm_errstring(mcib.mci_errno));
1345 ** MCI_PURGE_PERSISTENT -- Remove a persistence status file.
1348 ** pathname -- path to the status file.
1349 ** hostname -- name of host corresponding to that file.
1350 ** NULL if this is a directory (domain).
1354 ** 1 -- file not deleted (too young, incorrect format)
1355 ** < 0 -- some error occurred
1359 mci_purge_persistent(pathname, hostname)
1363 struct stat statbuf;
1364 char *end = pathname + strlen(pathname) - 1;
1368 sm_dprintf("mci_purge_persistent: purging %s\n", pathname);
1370 ret = stat(pathname, &statbuf);
1374 sm_dprintf("mci_purge_persistent: Failed to stat %s: %s\n",
1375 pathname, sm_errstring(errno));
1378 if (curtime() - statbuf.st_mtime <= MciInfoTimeout)
1380 if (hostname != NULL)
1382 /* remove the file */
1383 ret = unlink(pathname);
1387 sm_syslog(LOG_ERR, NOQID,
1388 "mci_purge_persistent: failed to unlink %s: %s",
1389 pathname, sm_errstring(errno));
1391 sm_dprintf("mci_purge_persistent: failed to unlink %s: %s\n",
1392 pathname, sm_errstring(errno));
1398 /* remove the directory */
1403 sm_dprintf("mci_purge_persistent: dpurge %s\n", pathname);
1405 ret = rmdir(pathname);
1409 sm_dprintf("mci_purge_persistent: rmdir %s: %s\n",
1410 pathname, sm_errstring(errno));
1418 ** MCI_GENERATE_PERSISTENT_PATH -- generate path from hostname
1420 ** Given `host', convert from a.b.c to $HostStatDir/c./b./a,
1421 ** putting the result into `path'. if `createflag' is set, intervening
1422 ** directories will be created as needed.
1425 ** host -- host name to convert from.
1426 ** path -- place to store result.
1427 ** pathlen -- length of path buffer.
1428 ** createflag -- if set, create intervening directories as
1437 mci_generate_persistent_path(host, path, pathlen, createflag)
1443 char *elem, *p, *x, ch;
1446 char t_host[MAXHOSTNAMELEN];
1448 struct in6_addr in6_addr;
1449 #endif /* NETINET6 */
1452 ** Rationality check the arguments.
1457 syserr("mci_generate_persistent_path: null host");
1462 syserr("mci_generate_persistent_path: null path");
1467 sm_dprintf("mci_generate_persistent_path(%s): ", host);
1469 if (*host == '\0' || *host == '.')
1472 /* make certain this is not a bracketed host number */
1473 if (strlen(host) > sizeof t_host - 1)
1476 (void) sm_strlcpy(t_host, host + 1, sizeof t_host);
1478 (void) sm_strlcpy(t_host, host, sizeof t_host);
1481 ** Delete any trailing dots from the hostname.
1482 ** Leave 'elem' pointing at the \0.
1485 elem = t_host + strlen(t_host);
1486 while (elem > t_host &&
1487 (elem[-1] == '.' || (host[0] == '[' && elem[-1] == ']')))
1490 /* check for bogus bracketed address */
1495 if (anynet_pton(AF_INET6, t_host, &in6_addr) == 1)
1497 # endif /* NETINET6 */
1499 if (inet_addr(t_host) != INADDR_NONE)
1501 # endif /* NETINET */
1506 /* check for what will be the final length of the path */
1507 len = strlen(HostStatDir) + 2;
1508 for (p = (char *) t_host; *p != '\0'; p++)
1513 if (p[0] == '.' && p[1] == '.')
1516 if (len > pathlen || len < 1)
1518 (void) sm_strlcpy(path, HostStatDir, pathlen);
1519 p = path + strlen(path);
1520 while (elem > t_host)
1522 if (!path_is_dir(path, createflag))
1528 while (elem >= t_host && *elem != '.')
1532 while ((ch = *x++) != '\0' && ch != '.')
1534 if (isascii(ch) && isupper(ch))
1537 ch = ':'; /* / -> : */
1547 sm_dprintf("FAILURE %d\n", ret);
1549 sm_dprintf("SUCCESS %s\n", path);