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.
17 SM_RCSID("@(#)$Id: mci.c,v 8.214 2005/02/04 22:01:45 ca Exp $")
19 #if NETINET || NETINET6
20 # include <arpa/inet.h>
21 #endif /* NETINET || NETINET6 */
25 static int mci_generate_persistent_path __P((const char *, char *,
27 static bool mci_load_persistent __P((MCI *));
28 static void mci_uncache __P((MCI **, bool));
29 static int mci_lock_host_statfile __P((MCI *));
30 static int mci_read_persistent __P((SM_FILE_T *, MCI *));
33 ** Mail Connection Information (MCI) Caching Module.
35 ** There are actually two separate things cached. The first is
36 ** the set of all open connections -- these are stored in a
37 ** (small) list. The second is stored in the symbol table; it
38 ** has the overall status for all hosts, whether or not there
39 ** is a connection open currently.
41 ** There should never be too many connections open (since this
42 ** could flood the socket table), nor should a connection be
43 ** allowed to sit idly for too long.
45 ** MaxMciCache is the maximum number of open connections that
48 ** MciCacheTimeout is the time (in seconds) that a connection
49 ** is permitted to survive without activity.
51 ** We actually try any cached connections by sending a NOOP
52 ** before we use them; if the NOOP fails we close down the
53 ** connection and reopen it. Note that this means that a
54 ** server SMTP that doesn't support NOOP will hose the
55 ** algorithm -- but that doesn't seem too likely.
57 ** The persistent MCI code is donated by Mark Lovell and Paul
58 ** Vixie. It is based on the long term host status code in KJS
59 ** written by Paul but has been adapted by Mark to fit into the
63 static MCI **MciCache; /* the open connection cache */
66 ** MCI_CACHE -- enter a connection structure into the open connection cache
68 ** This may cause something else to be flushed.
71 ** mci -- the connection to cache.
81 register MCI **mcislot;
84 ** Find the best slot. This may cause expired connections
88 mcislot = mci_scan(mci);
91 /* we don't support caching */
95 if (mci->mci_host == NULL)
98 /* if this is already cached, we are done */
99 if (bitset(MCIF_CACHED, mci->mci_flags))
102 /* otherwise we may have to clear the slot */
103 if (*mcislot != NULL)
104 mci_uncache(mcislot, true);
107 sm_dprintf("mci_cache: caching %p (%s) in slot %d\n",
108 mci, mci->mci_host, (int) (mcislot - MciCache));
110 sm_syslog(LOG_DEBUG, CurEnv->e_id,
111 "mci_cache: caching %lx (%.100s) in slot %d",
112 (unsigned long) mci, mci->mci_host,
113 (int) (mcislot - MciCache));
116 mci->mci_flags |= MCIF_CACHED;
119 ** MCI_SCAN -- scan the cache, flush junk, and return best slot
122 ** savemci -- never flush this one. Can be null.
125 ** The LRU (or empty) slot.
133 register MCI **bestmci;
137 if (MaxMciCache <= 0)
139 /* we don't support caching */
143 if (MciCache == NULL)
146 MciCache = (MCI **) sm_pmalloc_x(MaxMciCache * sizeof *MciCache);
147 memset((char *) MciCache, '\0', MaxMciCache * sizeof *MciCache);
152 bestmci = &MciCache[0];
153 for (i = 0; i < MaxMciCache; i++)
156 if (mci == NULL || mci->mci_state == MCIS_CLOSED)
158 bestmci = &MciCache[i];
161 if ((mci->mci_lastuse + MciCacheTimeout <= now ||
162 (mci->mci_mailer != NULL &&
163 mci->mci_mailer->m_maxdeliveries > 0 &&
164 mci->mci_deliveries + 1 >= mci->mci_mailer->m_maxdeliveries))&&
167 /* connection idle too long or too many deliveries */
168 bestmci = &MciCache[i];
171 mci_uncache(bestmci, true);
174 if (*bestmci == NULL)
176 if (mci->mci_lastuse < (*bestmci)->mci_lastuse)
177 bestmci = &MciCache[i];
182 ** MCI_UNCACHE -- remove a connection from a slot.
184 ** May close a connection.
187 ** mcislot -- the slot to empty.
188 ** doquit -- if true, send QUIT protocol on this connection.
189 ** if false, we are assumed to be in a forked child;
190 ** all we want to do is close the file(s).
197 mci_uncache(mcislot, doquit)
198 register MCI **mcislot;
202 extern ENVELOPE BlankEnvelope;
208 if (mci->mci_host == NULL)
211 mci_unlock_host(mci);
214 sm_dprintf("mci_uncache: uncaching %p (%s) from slot %d (%d)\n",
215 mci, mci->mci_host, (int) (mcislot - MciCache),
218 sm_syslog(LOG_DEBUG, CurEnv->e_id,
219 "mci_uncache: uncaching %lx (%.100s) from slot %d (%d)",
220 (unsigned long) mci, mci->mci_host,
221 (int) (mcislot - MciCache), doquit);
223 mci->mci_deliveries = 0;
226 message("Closing connection to %s", mci->mci_host);
228 mci->mci_flags &= ~MCIF_CACHED;
230 /* only uses the envelope to flush the transcript file */
231 if (mci->mci_state != MCIS_CLOSED)
232 smtpquit(mci->mci_mailer, mci, &BlankEnvelope);
234 xla_host_end(mci->mci_host);
239 if (mci->mci_in != NULL)
240 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
241 if (mci->mci_out != NULL)
242 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
243 mci->mci_in = mci->mci_out = NULL;
244 mci->mci_state = MCIS_CLOSED;
245 mci->mci_exitstat = EX_OK;
249 mci->mci_retryrcpt = false;
250 mci->mci_tolist = NULL;
252 mci->mci_okrcpts = 0;
253 #endif /* PIPELINING */
256 SM_FREE_CLR(mci->mci_status);
257 SM_FREE_CLR(mci->mci_rstatus);
258 SM_FREE_CLR(mci->mci_heloname);
259 if (mci->mci_rpool != NULL)
261 sm_rpool_free(mci->mci_rpool);
262 mci->mci_macro.mac_rpool = NULL;
263 mci->mci_rpool = NULL;
267 ** MCI_FLUSH -- flush the entire cache
270 ** doquit -- if true, send QUIT protocol.
271 ** if false, just close the connection.
272 ** allbut -- but leave this one open.
279 mci_flush(doquit, allbut)
285 if (MciCache == NULL)
288 for (i = 0; i < MaxMciCache; i++)
290 if (allbut != MciCache[i])
291 mci_uncache(&MciCache[i], doquit);
295 ** MCI_GET -- get information about a particular host
298 ** host -- host to look for.
302 ** mci for this host (might be new).
312 extern SOCKADDR CurHostAddr;
314 /* clear CurHostAddr so we don't get a bogus address with this name */
315 memset(&CurHostAddr, '\0', sizeof CurHostAddr);
317 /* clear out any expired connections */
318 (void) mci_scan(NULL);
321 syserr("!negative mno %d (%s)", m->m_mno, m->m_name);
323 s = stab(host, ST_MCI + m->m_mno, ST_ENTER);
326 /* initialize per-message data */
327 mci->mci_retryrcpt = false;
328 mci->mci_tolist = NULL;
330 mci->mci_okrcpts = 0;
331 #endif /* PIPELINING */
333 if (mci->mci_rpool == NULL)
334 mci->mci_rpool = sm_rpool_new_x(NULL);
336 if (mci->mci_macro.mac_rpool == NULL)
337 mci->mci_macro.mac_rpool = mci->mci_rpool;
340 ** We don't need to load the persistent data if we have data
341 ** already loaded in the cache.
344 if (mci->mci_host == NULL &&
345 (mci->mci_host = s->s_name) != NULL &&
346 !mci_load_persistent(mci))
349 sm_dprintf("mci_get(%s %s): lock failed\n",
351 mci->mci_exitstat = EX_TEMPFAIL;
352 mci->mci_state = MCIS_CLOSED;
353 mci->mci_statfile = NULL;
359 sm_dprintf("mci_get(%s %s): mci_state=%d, _flags=%lx, _exitstat=%d, _errno=%d\n",
360 host, m->m_name, mci->mci_state, mci->mci_flags,
361 mci->mci_exitstat, mci->mci_errno);
364 if (mci->mci_state == MCIS_OPEN)
366 /* poke the connection to see if it's still alive */
367 (void) smtpprobe(mci);
369 /* reset the stored state in the event of a timeout */
370 if (mci->mci_state != MCIS_OPEN)
373 mci->mci_exitstat = EX_OK;
374 mci->mci_state = MCIS_CLOSED;
378 /* get peer host address */
379 /* (this should really be in the mci struct) */
380 SOCKADDR_LEN_T socklen = sizeof CurHostAddr;
382 (void) getpeername(sm_io_getinfo(mci->mci_in,
383 SM_IO_WHAT_FD, NULL),
384 (struct sockaddr *) &CurHostAddr, &socklen);
387 if (mci->mci_state == MCIS_CLOSED)
389 time_t now = curtime();
391 /* if this info is stale, ignore it */
392 if (mci->mci_lastuse + MciInfoTimeout <= now)
394 mci->mci_lastuse = now;
396 mci->mci_exitstat = EX_OK;
404 ** MCI_CLOSE -- (forcefully) close files used for a connection.
405 ** Note: this is a last resort, usually smtpquit() or endmailer()
406 ** should be used to close a connection.
409 ** mci -- the connection to close.
410 ** where -- where has this been called?
417 mci_close(mci, where)
426 if (mci->mci_out != NULL)
430 sm_dprintf("mci_close: mci_out!=NULL, where=%s\n",
432 mci_dump(sm_debug_file(), mci, false);
435 (void) sm_io_close(mci->mci_out, SM_TIME_DEFAULT);
438 if (mci->mci_in != NULL)
442 sm_dprintf("mci_close: mci_in!=NULL, where=%s\n",
445 mci_dump(sm_debug_file(), mci, false);
447 (void) sm_io_close(mci->mci_in, SM_TIME_DEFAULT);
450 mci->mci_state = MCIS_CLOSED;
454 ** MCI_NEW -- allocate new MCI structure
457 ** rpool -- if non-NULL: allocate from that rpool.
470 mci = (MCI *) sm_malloc_x(sizeof *mci);
472 mci = (MCI *) sm_rpool_malloc_x(rpool, sizeof *mci);
473 memset((char *) mci, '\0', sizeof *mci);
474 mci->mci_rpool = sm_rpool_new_x(NULL);
475 mci->mci_macro.mac_rpool = mci->mci_rpool;
479 ** MCI_MATCH -- check connection cache for a particular host
482 ** host -- host to look for.
486 ** true iff open connection exists.
497 if (m->m_mno < 0 || m->m_mno > MAXMAILERS)
499 s = stab(host, ST_MCI + m->m_mno, ST_FIND);
504 return mci->mci_state == MCIS_OPEN;
507 ** MCI_SETSTAT -- set status codes in MCI structure.
510 ** mci -- the MCI structure to set.
511 ** xstat -- the exit status code.
512 ** dstat -- the DSN status code.
513 ** rstat -- the SMTP status code.
520 mci_setstat(mci, xstat, dstat, rstat)
526 /* protocol errors should never be interpreted as sticky */
527 if (xstat != EX_NOTSTICKY && xstat != EX_PROTOCOL)
528 mci->mci_exitstat = xstat;
530 SM_FREE_CLR(mci->mci_status);
532 mci->mci_status = sm_strdup_x(dstat);
534 SM_FREE_CLR(mci->mci_rstatus);
536 mci->mci_rstatus = sm_strdup_x(rstat);
539 ** MCI_DUMP -- dump the contents of an MCI structure.
542 ** fp -- output file pointer
543 ** mci -- the MCI structure to dump.
554 int mcif_bit; /* flag bit */
555 char *mcif_name; /* flag name */
557 static struct mcifbits MciFlags[] =
559 { MCIF_VALID, "VALID" },
560 { MCIF_CACHED, "CACHED" },
561 { MCIF_ESMTP, "ESMTP" },
562 { MCIF_EXPN, "EXPN" },
563 { MCIF_SIZE, "SIZE" },
564 { MCIF_8BITMIME, "8BITMIME" },
565 { MCIF_7BIT, "7BIT" },
566 { MCIF_INHEADER, "INHEADER" },
567 { MCIF_CVT8TO7, "CVT8TO7" },
569 { MCIF_8BITOK, "8BITOK" },
570 { MCIF_CVT7TO8, "CVT7TO8" },
571 { MCIF_INMIME, "INMIME" },
572 { MCIF_AUTH, "AUTH" },
573 { MCIF_AUTHACT, "AUTHACT" },
574 { MCIF_ENHSTAT, "ENHSTAT" },
575 { MCIF_PIPELINED, "PIPELINED" },
578 { MCIF_TLSACT, "TLSACT" },
579 #endif /* STARTTLS */
580 { MCIF_DLVR_BY, "DLVR_BY" },
585 mci_dump(fp, mci, logit)
594 sep = logit ? " " : "\n\t";
596 (void) sm_snprintf(p, SPACELEFT(buf, p), "MCI@%p: ", mci);
600 (void) sm_snprintf(p, SPACELEFT(buf, p), "NULL");
603 (void) sm_snprintf(p, SPACELEFT(buf, p), "flags=%lx", mci->mci_flags);
607 ** The following check is just for paranoia. It protects the
608 ** assignment in the if() clause. If there's not some minimum
609 ** amount of space we can stop right now. The check will not
610 ** trigger as long as sizeof(buf)=4000.
613 if (p >= buf + sizeof(buf) - 4)
615 if (mci->mci_flags != 0)
619 *p++ = '<'; /* protected above */
620 for (f = MciFlags; f->mcif_bit != 0; f++)
622 if (!bitset(f->mcif_bit, mci->mci_flags))
624 (void) sm_strlcpyn(p, SPACELEFT(buf, p), 2,
631 /* Note: sm_snprintf() takes care of NULL arguments for %s */
632 (void) sm_snprintf(p, SPACELEFT(buf, p),
633 ",%serrno=%d, herrno=%d, exitstat=%d, state=%d, pid=%d,%s",
634 sep, mci->mci_errno, mci->mci_herrno,
635 mci->mci_exitstat, mci->mci_state, (int) mci->mci_pid, sep);
637 (void) sm_snprintf(p, SPACELEFT(buf, p),
638 "maxsize=%ld, phase=%s, mailer=%s,%s",
639 mci->mci_maxsize, mci->mci_phase,
640 mci->mci_mailer == NULL ? "NULL" : mci->mci_mailer->m_name,
643 (void) sm_snprintf(p, SPACELEFT(buf, p),
644 "status=%s, rstatus=%s,%s",
645 mci->mci_status, mci->mci_rstatus, sep);
647 (void) sm_snprintf(p, SPACELEFT(buf, p),
648 "host=%s, lastuse=%s",
649 mci->mci_host, ctime(&mci->mci_lastuse));
652 sm_syslog(LOG_DEBUG, CurEnv->e_id, "%.1000s", buf);
654 (void) sm_io_fprintf(fp, SM_TIME_DEFAULT, "%s\n", buf);
657 ** MCI_DUMP_ALL -- print the entire MCI cache
660 ** fp -- output file pointer
661 ** logit -- if set, log the result instead of printing
669 mci_dump_all(fp, logit)
675 if (MciCache == NULL)
678 for (i = 0; i < MaxMciCache; i++)
679 mci_dump(fp, MciCache[i], logit);
682 ** MCI_LOCK_HOST -- Lock host while sending.
684 ** If we are contacting a host, we'll need to
685 ** update the status information in the host status
686 ** file, and if we want to do that, we ought to have
687 ** locked it. This has the (according to some)
688 ** desirable effect of serializing connectivity with
689 ** remote hosts -- i.e.: one connection to a given
693 ** mci -- containing the host we want to lock.
696 ** EX_OK -- got the lock.
697 ** EX_TEMPFAIL -- didn't get the lock.
707 sm_dprintf("mci_lock_host: NULL mci\n");
711 if (!SingleThreadDelivery)
714 return mci_lock_host_statfile(mci);
718 mci_lock_host_statfile(mci)
721 int save_errno = errno;
723 char fname[MAXPATHLEN];
725 if (HostStatDir == NULL || mci->mci_host == NULL)
729 sm_dprintf("mci_lock_host: attempting to lock %s\n",
732 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof fname,
735 /* of course this should never happen */
737 sm_dprintf("mci_lock_host: Failed to generate host path for %s\n",
740 retVal = EX_TEMPFAIL;
744 mci->mci_statfile = safefopen(fname, O_RDWR, FileMode,
745 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH|SFF_CREAT);
747 if (mci->mci_statfile == NULL)
749 syserr("mci_lock_host: cannot create host lock file %s", fname);
753 if (!lockfile(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
754 fname, "", LOCK_EX|LOCK_NB))
757 sm_dprintf("mci_lock_host: couldn't get lock on %s\n",
759 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
760 mci->mci_statfile = NULL;
761 retVal = EX_TEMPFAIL;
765 if (tTd(56, 12) && mci->mci_statfile != NULL)
766 sm_dprintf("mci_lock_host: Sanity check -- lock is good\n");
773 ** MCI_UNLOCK_HOST -- unlock host
775 ** Clean up the lock on a host, close the file, let
776 ** someone else use it.
789 int save_errno = errno;
794 sm_dprintf("mci_unlock_host: NULL mci\n");
798 if (HostStatDir == NULL || mci->mci_host == NULL)
801 if (!SingleThreadDelivery && mci_lock_host_statfile(mci) == EX_TEMPFAIL)
804 sm_dprintf("mci_unlock_host: stat file already locked\n");
809 sm_dprintf("mci_unlock_host: store prior to unlock\n");
810 mci_store_persistent(mci);
813 if (mci->mci_statfile != NULL)
815 (void) sm_io_close(mci->mci_statfile, SM_TIME_DEFAULT);
816 mci->mci_statfile = NULL;
822 ** MCI_LOAD_PERSISTENT -- load persistent host info
824 ** Load information about host that is kept
825 ** in common for all running sendmails.
828 ** mci -- the host/connection to load persistent info for.
831 ** true -- lock was successful
832 ** false -- lock failed
836 mci_load_persistent(mci)
839 int save_errno = errno;
842 char fname[MAXPATHLEN];
847 sm_dprintf("mci_load_persistent: NULL mci\n");
851 if (IgnoreHostStatus || HostStatDir == NULL || mci->mci_host == NULL)
854 /* Already have the persistent information in memory */
855 if (SingleThreadDelivery && mci->mci_statfile != NULL)
859 sm_dprintf("mci_load_persistent: Attempting to load persistent information for %s\n",
862 if (mci_generate_persistent_path(mci->mci_host, fname, sizeof fname,
865 /* Not much we can do if the file isn't there... */
867 sm_dprintf("mci_load_persistent: Couldn't generate host path\n");
871 fp = safefopen(fname, O_RDONLY, FileMode,
872 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
875 /* I can't think of any reason this should ever happen */
877 sm_dprintf("mci_load_persistent: open(%s): %s\n",
878 fname, sm_errstring(errno));
883 locked = lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname, "",
887 (void) mci_read_persistent(fp, mci);
888 (void) lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), fname,
892 (void) sm_io_close(fp, SM_TIME_DEFAULT);
899 ** MCI_READ_PERSISTENT -- read persistent host status file
902 ** fp -- the file pointer to read.
903 ** mci -- the pointer to fill in.
906 ** -1 -- if the file was corrupt.
910 ** This code makes the assumption that this data
911 ** will be read in an atomic fashion, and that the data
912 ** was written in an atomic fashion. Any other functioning
913 ** may lead to some form of insanity. This should be
914 ** perfectly safe due to underlying stdio buffering.
918 mci_read_persistent(fp, mci)
924 int saveLineNumber = LineNumber;
928 syserr("mci_read_persistent: NULL fp");
930 syserr("mci_read_persistent: NULL mci");
933 sm_dprintf("mci_read_persistent: fp=%lx, mci=",
937 SM_FREE_CLR(mci->mci_status);
938 SM_FREE_CLR(mci->mci_rstatus);
940 sm_io_rewind(fp, SM_TIME_DEFAULT);
943 while (sm_io_fgets(fp, SM_TIME_DEFAULT, buf, sizeof buf) != NULL)
946 p = strchr(buf, '\n');
951 case 'V': /* version stamp */
953 if (ver < 0 || ver > 0)
954 syserr("Unknown host status version %d: %d max",
958 case 'E': /* UNIX error number */
959 mci->mci_errno = atoi(&buf[1]);
962 case 'H': /* DNS error number */
963 mci->mci_herrno = atoi(&buf[1]);
966 case 'S': /* UNIX exit status */
967 mci->mci_exitstat = atoi(&buf[1]);
970 case 'D': /* DSN status */
971 mci->mci_status = newstr(&buf[1]);
974 case 'R': /* SMTP status */
975 mci->mci_rstatus = newstr(&buf[1]);
978 case 'U': /* last usage time */
979 mci->mci_lastuse = atol(&buf[1]);
982 case '.': /* end of file */
984 mci_dump(sm_debug_file(), mci, false);
988 sm_syslog(LOG_CRIT, NOQID,
989 "%s: line %d: Unknown host status line \"%s\"",
990 FileName == NULL ? mci->mci_host : FileName,
992 LineNumber = saveLineNumber;
996 LineNumber = saveLineNumber;
998 sm_dprintf("incomplete (missing dot for EOF)\n");
1004 ** MCI_STORE_PERSISTENT -- Store persistent MCI information
1006 ** Store information about host that is kept
1007 ** in common for all running sendmails.
1010 ** mci -- the host/connection to store persistent info for.
1017 mci_store_persistent(mci)
1020 int save_errno = errno;
1025 sm_dprintf("mci_store_persistent: NULL mci\n");
1029 if (HostStatDir == NULL || mci->mci_host == NULL)
1033 sm_dprintf("mci_store_persistent: Storing information for %s\n",
1036 if (mci->mci_statfile == NULL)
1039 sm_dprintf("mci_store_persistent: no statfile\n");
1043 sm_io_rewind(mci->mci_statfile, SM_TIME_DEFAULT);
1045 (void) ftruncate(sm_io_getinfo(mci->mci_statfile, SM_IO_WHAT_FD, NULL),
1047 #endif /* !NOFTRUNCATE */
1049 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "V0\n");
1050 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "E%d\n",
1052 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "H%d\n",
1054 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "S%d\n",
1056 if (mci->mci_status != NULL)
1057 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1059 denlstring(mci->mci_status, true, false));
1060 if (mci->mci_rstatus != NULL)
1061 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT,
1063 denlstring(mci->mci_rstatus, true, false));
1064 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, "U%ld\n",
1065 (long)(mci->mci_lastuse));
1066 (void) sm_io_fprintf(mci->mci_statfile, SM_TIME_DEFAULT, ".\n");
1068 (void) sm_io_flush(mci->mci_statfile, SM_TIME_DEFAULT);
1074 ** MCI_TRAVERSE_PERSISTENT -- walk persistent status tree
1076 ** Recursively find all the mci host files in `pathname'. Default to
1077 ** main host status directory if no path is provided.
1078 ** Call (*action)(pathname, host) for each file found.
1080 ** Note: all information is collected in a list before it is processed.
1081 ** This may not be the best way to do it, but it seems safest, since
1082 ** the file system would be touched while we are attempting to traverse
1083 ** the directory tree otherwise (during purges).
1086 ** action -- function to call on each node. If returns < 0,
1087 ** return immediately.
1088 ** pathname -- root of tree. If null, use main host status
1092 ** < 0 -- if any action routine returns a negative value, that
1093 ** value is returned.
1094 ** 0 -- if we successfully went to completion.
1095 ** > 0 -- return status from action()
1099 mci_traverse_persistent(action, pathname)
1100 int (*action)__P((char *, char *));
1103 struct stat statbuf;
1107 if (pathname == NULL)
1108 pathname = HostStatDir;
1109 if (pathname == NULL)
1113 sm_dprintf("mci_traverse: pathname is %s\n", pathname);
1115 ret = stat(pathname, &statbuf);
1119 sm_dprintf("mci_traverse: Failed to stat %s: %s\n",
1120 pathname, sm_errstring(errno));
1123 if (S_ISDIR(statbuf.st_mode))
1125 bool leftone, removedone;
1129 char newpath[MAXPATHLEN];
1131 if ((d = opendir(pathname)) == NULL)
1134 sm_dprintf("mci_traverse: opendir %s: %s\n",
1135 pathname, sm_errstring(errno));
1138 len = sizeof(newpath) - MAXNAMLEN - 3;
1139 if (sm_strlcpy(newpath, pathname, len) >= len)
1142 sm_dprintf("mci_traverse: path \"%s\" too long",
1146 newptr = newpath + strlen(newpath);
1150 ** repeat until no file has been removed
1151 ** this may become ugly when several files "expire"
1152 ** during these loops, but it's better than doing
1153 ** a rewinddir() inside the inner loop
1158 leftone = removedone = false;
1159 while ((e = readdir(d)) != NULL)
1161 if (e->d_name[0] == '.')
1164 (void) sm_strlcpy(newptr, e->d_name,
1166 (newptr - newpath));
1170 ret = mci_traverse_persistent(action, newpath);
1175 if (!removedone && ret == 0 &&
1176 action == mci_purge_persistent)
1183 ** The following appears to be
1184 ** necessary during purges, since
1185 ** we modify the directory structure
1191 sm_dprintf("mci_traverse: path %s: ret %d removed %d left %d\n",
1192 pathname, ret, removedone, leftone);
1193 } while (removedone);
1195 /* purge (or whatever) the directory proper */
1199 ret = (*action)(newpath, NULL);
1203 else if (S_ISREG(statbuf.st_mode))
1205 char *end = pathname + strlen(pathname) - 1;
1208 char host[MAXHOSTNAMELEN];
1209 char *hostptr = host;
1212 ** Reconstruct the host name from the path to the
1213 ** persistent information.
1218 if (hostptr != host)
1221 while (start > pathname && *(start - 1) != '/')
1227 for (scan = start; scan <= end; scan++)
1228 *(hostptr++) = *scan;
1231 } while (end > pathname && *end == '.');
1236 ** Do something with the file containing the persistent
1240 ret = (*action)(pathname, host);
1246 ** MCI_PRINT_PERSISTENT -- print persistent info
1248 ** Dump the persistent information in the file 'pathname'
1251 ** pathname -- the pathname to the status file.
1252 ** hostname -- the corresponding host name.
1259 mci_print_persistent(pathname, hostname)
1263 static bool initflag = false;
1265 int width = Verbose ? 78 : 25;
1269 /* skip directories */
1270 if (hostname == NULL)
1279 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1280 " -------------- Hostname --------------- How long ago ---------Results---------\n");
1283 fp = safefopen(pathname, O_RDONLY, FileMode,
1284 SFF_NOLOCK|SFF_NOLINK|SFF_OPENASROOT|SFF_REGONLY|SFF_SAFEDIRPATH);
1289 sm_dprintf("mci_print_persistent: cannot open %s: %s\n",
1290 pathname, sm_errstring(errno));
1294 FileName = pathname;
1295 memset(&mcib, '\0', sizeof mcib);
1296 if (mci_read_persistent(fp, &mcib) < 0)
1298 syserr("%s: could not read status file", pathname);
1299 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1304 locked = !lockfile(sm_io_getinfo(fp, SM_IO_WHAT_FD, NULL), pathname,
1305 "", LOCK_SH|LOCK_NB);
1306 (void) sm_io_close(fp, SM_TIME_DEFAULT);
1309 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%c%-39s %12s ",
1310 locked ? '*' : ' ', hostname,
1311 pintvl(curtime() - mcib.mci_lastuse, true));
1312 if (mcib.mci_rstatus != NULL)
1313 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n", width,
1315 else if (mcib.mci_exitstat == EX_TEMPFAIL && mcib.mci_errno != 0)
1316 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT,
1317 "Deferred: %.*s\n", width - 10,
1318 sm_errstring(mcib.mci_errno));
1319 else if (mcib.mci_exitstat != 0)
1321 char *exmsg = sm_sysexmsg(mcib.mci_exitstat);
1327 (void) sm_snprintf(buf, sizeof buf,
1328 "Unknown mailer error %d",
1330 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1334 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "%.*s\n",
1337 else if (mcib.mci_errno == 0)
1338 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK\n");
1340 (void) sm_io_fprintf(smioout, SM_TIME_DEFAULT, "OK: %.*s\n",
1341 width - 4, sm_errstring(mcib.mci_errno));
1346 ** MCI_PURGE_PERSISTENT -- Remove a persistence status file.
1349 ** pathname -- path to the status file.
1350 ** hostname -- name of host corresponding to that file.
1351 ** NULL if this is a directory (domain).
1355 ** 1 -- file not deleted (too young, incorrect format)
1356 ** < 0 -- some error occurred
1360 mci_purge_persistent(pathname, hostname)
1364 struct stat statbuf;
1365 char *end = pathname + strlen(pathname) - 1;
1369 sm_dprintf("mci_purge_persistent: purging %s\n", pathname);
1371 ret = stat(pathname, &statbuf);
1375 sm_dprintf("mci_purge_persistent: Failed to stat %s: %s\n",
1376 pathname, sm_errstring(errno));
1379 if (curtime() - statbuf.st_mtime <= MciInfoTimeout)
1381 if (hostname != NULL)
1383 /* remove the file */
1384 ret = unlink(pathname);
1388 sm_syslog(LOG_ERR, NOQID,
1389 "mci_purge_persistent: failed to unlink %s: %s",
1390 pathname, sm_errstring(errno));
1392 sm_dprintf("mci_purge_persistent: failed to unlink %s: %s\n",
1393 pathname, sm_errstring(errno));
1399 /* remove the directory */
1404 sm_dprintf("mci_purge_persistent: dpurge %s\n", pathname);
1406 ret = rmdir(pathname);
1410 sm_dprintf("mci_purge_persistent: rmdir %s: %s\n",
1411 pathname, sm_errstring(errno));
1419 ** MCI_GENERATE_PERSISTENT_PATH -- generate path from hostname
1421 ** Given `host', convert from a.b.c to $HostStatDir/c./b./a,
1422 ** putting the result into `path'. if `createflag' is set, intervening
1423 ** directories will be created as needed.
1426 ** host -- host name to convert from.
1427 ** path -- place to store result.
1428 ** pathlen -- length of path buffer.
1429 ** createflag -- if set, create intervening directories as
1438 mci_generate_persistent_path(host, path, pathlen, createflag)
1444 char *elem, *p, *x, ch;
1447 char t_host[MAXHOSTNAMELEN];
1449 struct in6_addr in6_addr;
1450 #endif /* NETINET6 */
1453 ** Rationality check the arguments.
1458 syserr("mci_generate_persistent_path: null host");
1463 syserr("mci_generate_persistent_path: null path");
1468 sm_dprintf("mci_generate_persistent_path(%s): ", host);
1470 if (*host == '\0' || *host == '.')
1473 /* make certain this is not a bracketed host number */
1474 if (strlen(host) > sizeof t_host - 1)
1477 (void) sm_strlcpy(t_host, host + 1, sizeof t_host);
1479 (void) sm_strlcpy(t_host, host, sizeof t_host);
1482 ** Delete any trailing dots from the hostname.
1483 ** Leave 'elem' pointing at the \0.
1486 elem = t_host + strlen(t_host);
1487 while (elem > t_host &&
1488 (elem[-1] == '.' || (host[0] == '[' && elem[-1] == ']')))
1491 /* check for bogus bracketed address */
1496 if (anynet_pton(AF_INET6, t_host, &in6_addr) == 1)
1498 # endif /* NETINET6 */
1500 if (inet_addr(t_host) != INADDR_NONE)
1502 # endif /* NETINET */
1507 /* check for what will be the final length of the path */
1508 len = strlen(HostStatDir) + 2;
1509 for (p = (char *) t_host; *p != '\0'; p++)
1514 if (p[0] == '.' && p[1] == '.')
1517 if (len > pathlen || len < 1)
1519 (void) sm_strlcpy(path, HostStatDir, pathlen);
1520 p = path + strlen(path);
1521 while (elem > t_host)
1523 if (!path_is_dir(path, createflag))
1529 while (elem >= t_host && *elem != '.')
1533 while ((ch = *x++) != '\0' && ch != '.')
1535 if (isascii(ch) && isupper(ch))
1538 ch = ':'; /* / -> : */
1548 sm_dprintf("FAILURE %d\n", ret);
1550 sm_dprintf("SUCCESS %s\n", path);