2 * Copyright (c) 1998-2003 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.
12 * $FreeBSD: src/contrib/sendmail/src/mci.c,v 1.3.6.12 2003/10/30 22:31:44 gshapiro Exp $
17 SM_RCSID("@(#)$Id: mci.c,v 8.205.2.4 2003/03/31 17:35:27 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
;
403 ** MCI_NEW -- allocate new MCI structure
406 ** rpool -- if non-NULL: allocate from that rpool.
419 mci
= (MCI
*) sm_malloc_x(sizeof *mci
);
421 mci
= (MCI
*) sm_rpool_malloc_x(rpool
, sizeof *mci
);
422 memset((char *) mci
, '\0', sizeof *mci
);
423 mci
->mci_rpool
= sm_rpool_new_x(NULL
);
424 mci
->mci_macro
.mac_rpool
= mci
->mci_rpool
;
428 ** MCI_MATCH -- check connection cache for a particular host
431 ** host -- host to look for.
435 ** true iff open connection exists.
446 if (m
->m_mno
< 0 || m
->m_mno
> MAXMAILERS
)
448 s
= stab(host
, ST_MCI
+ m
->m_mno
, ST_FIND
);
453 return mci
->mci_state
== MCIS_OPEN
;
456 ** MCI_SETSTAT -- set status codes in MCI structure.
459 ** mci -- the MCI structure to set.
460 ** xstat -- the exit status code.
461 ** dstat -- the DSN status code.
462 ** rstat -- the SMTP status code.
469 mci_setstat(mci
, xstat
, dstat
, rstat
)
475 /* protocol errors should never be interpreted as sticky */
476 if (xstat
!= EX_NOTSTICKY
&& xstat
!= EX_PROTOCOL
)
477 mci
->mci_exitstat
= xstat
;
479 SM_FREE_CLR(mci
->mci_status
);
481 mci
->mci_status
= sm_strdup_x(dstat
);
483 SM_FREE_CLR(mci
->mci_rstatus
);
485 mci
->mci_rstatus
= sm_strdup_x(rstat
);
488 ** MCI_DUMP -- dump the contents of an MCI structure.
491 ** mci -- the MCI structure to dump.
502 int mcif_bit
; /* flag bit */
503 char *mcif_name
; /* flag name */
505 static struct mcifbits MciFlags
[] =
507 { MCIF_VALID
, "VALID" },
508 { MCIF_CACHED
, "CACHED" },
509 { MCIF_ESMTP
, "ESMTP" },
510 { MCIF_EXPN
, "EXPN" },
511 { MCIF_SIZE
, "SIZE" },
512 { MCIF_8BITMIME
, "8BITMIME" },
513 { MCIF_7BIT
, "7BIT" },
514 { MCIF_INHEADER
, "INHEADER" },
515 { MCIF_CVT8TO7
, "CVT8TO7" },
517 { MCIF_8BITOK
, "8BITOK" },
518 { MCIF_CVT7TO8
, "CVT7TO8" },
519 { MCIF_INMIME
, "INMIME" },
520 { MCIF_AUTH
, "AUTH" },
521 { MCIF_AUTHACT
, "AUTHACT" },
522 { MCIF_ENHSTAT
, "ENHSTAT" },
523 { MCIF_PIPELINED
, "PIPELINED" },
526 { MCIF_TLSACT
, "TLSACT" },
527 #endif /* STARTTLS */
528 { MCIF_DLVR_BY
, "DLVR_BY" },
541 sep
= logit
? " " : "\n\t";
543 (void) sm_snprintf(p
, SPACELEFT(buf
, p
), "MCI@%p: ", mci
);
547 (void) sm_snprintf(p
, SPACELEFT(buf
, p
), "NULL");
550 (void) sm_snprintf(p
, SPACELEFT(buf
, p
), "flags=%lx", mci
->mci_flags
);
554 ** The following check is just for paranoia. It protects the
555 ** assignment in the if() clause. If there's not some minimum
556 ** amount of space we can stop right now. The check will not
557 ** trigger as long as sizeof(buf)=4000.
560 if (p
>= buf
+ sizeof(buf
) - 4)
562 if (mci
->mci_flags
!= 0)
566 *p
++ = '<'; /* protected above */
567 for (f
= MciFlags
; f
->mcif_bit
!= 0; f
++)
569 if (!bitset(f
->mcif_bit
, mci
->mci_flags
))
571 (void) sm_strlcpyn(p
, SPACELEFT(buf
, p
), 2,
578 /* Note: sm_snprintf() takes care of NULL arguments for %s */
579 (void) sm_snprintf(p
, SPACELEFT(buf
, p
),
580 ",%serrno=%d, herrno=%d, exitstat=%d, state=%d, pid=%d,%s",
581 sep
, mci
->mci_errno
, mci
->mci_herrno
,
582 mci
->mci_exitstat
, mci
->mci_state
, (int) mci
->mci_pid
, sep
);
584 (void) sm_snprintf(p
, SPACELEFT(buf
, p
),
585 "maxsize=%ld, phase=%s, mailer=%s,%s",
586 mci
->mci_maxsize
, mci
->mci_phase
,
587 mci
->mci_mailer
== NULL
? "NULL" : mci
->mci_mailer
->m_name
,
590 (void) sm_snprintf(p
, SPACELEFT(buf
, p
),
591 "status=%s, rstatus=%s,%s",
592 mci
->mci_status
, mci
->mci_rstatus
, sep
);
594 (void) sm_snprintf(p
, SPACELEFT(buf
, p
),
595 "host=%s, lastuse=%s",
596 mci
->mci_host
, ctime(&mci
->mci_lastuse
));
599 sm_syslog(LOG_DEBUG
, CurEnv
->e_id
, "%.1000s", buf
);
601 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "%s\n", buf
);
604 ** MCI_DUMP_ALL -- print the entire MCI cache
607 ** logit -- if set, log the result instead of printing
620 if (MciCache
== NULL
)
623 for (i
= 0; i
< MaxMciCache
; i
++)
624 mci_dump(MciCache
[i
], logit
);
627 ** MCI_LOCK_HOST -- Lock host while sending.
629 ** If we are contacting a host, we'll need to
630 ** update the status information in the host status
631 ** file, and if we want to do that, we ought to have
632 ** locked it. This has the (according to some)
633 ** desirable effect of serializing connectivity with
634 ** remote hosts -- i.e.: one connection to a given
638 ** mci -- containing the host we want to lock.
641 ** EX_OK -- got the lock.
642 ** EX_TEMPFAIL -- didn't get the lock.
652 sm_dprintf("mci_lock_host: NULL mci\n");
656 if (!SingleThreadDelivery
)
659 return mci_lock_host_statfile(mci
);
663 mci_lock_host_statfile(mci
)
666 int save_errno
= errno
;
668 char fname
[MAXPATHLEN
];
670 if (HostStatDir
== NULL
|| mci
->mci_host
== NULL
)
674 sm_dprintf("mci_lock_host: attempting to lock %s\n",
677 if (mci_generate_persistent_path(mci
->mci_host
, fname
, sizeof fname
,
680 /* of course this should never happen */
682 sm_dprintf("mci_lock_host: Failed to generate host path for %s\n",
685 retVal
= EX_TEMPFAIL
;
689 mci
->mci_statfile
= safefopen(fname
, O_RDWR
, FileMode
,
690 SFF_NOLOCK
|SFF_NOLINK
|SFF_OPENASROOT
|SFF_REGONLY
|SFF_SAFEDIRPATH
|SFF_CREAT
);
692 if (mci
->mci_statfile
== NULL
)
694 syserr("mci_lock_host: cannot create host lock file %s", fname
);
698 if (!lockfile(sm_io_getinfo(mci
->mci_statfile
, SM_IO_WHAT_FD
, NULL
),
699 fname
, "", LOCK_EX
|LOCK_NB
))
702 sm_dprintf("mci_lock_host: couldn't get lock on %s\n",
704 (void) sm_io_close(mci
->mci_statfile
, SM_TIME_DEFAULT
);
705 mci
->mci_statfile
= NULL
;
706 retVal
= EX_TEMPFAIL
;
710 if (tTd(56, 12) && mci
->mci_statfile
!= NULL
)
711 sm_dprintf("mci_lock_host: Sanity check -- lock is good\n");
718 ** MCI_UNLOCK_HOST -- unlock host
720 ** Clean up the lock on a host, close the file, let
721 ** someone else use it.
734 int save_errno
= errno
;
739 sm_dprintf("mci_unlock_host: NULL mci\n");
743 if (HostStatDir
== NULL
|| mci
->mci_host
== NULL
)
746 if (!SingleThreadDelivery
&& mci_lock_host_statfile(mci
) == EX_TEMPFAIL
)
749 sm_dprintf("mci_unlock_host: stat file already locked\n");
754 sm_dprintf("mci_unlock_host: store prior to unlock\n");
755 mci_store_persistent(mci
);
758 if (mci
->mci_statfile
!= NULL
)
760 (void) sm_io_close(mci
->mci_statfile
, SM_TIME_DEFAULT
);
761 mci
->mci_statfile
= NULL
;
767 ** MCI_LOAD_PERSISTENT -- load persistent host info
769 ** Load information about host that is kept
770 ** in common for all running sendmails.
773 ** mci -- the host/connection to load persistent info for.
776 ** true -- lock was successful
777 ** false -- lock failed
781 mci_load_persistent(mci
)
784 int save_errno
= errno
;
787 char fname
[MAXPATHLEN
];
792 sm_dprintf("mci_load_persistent: NULL mci\n");
796 if (IgnoreHostStatus
|| HostStatDir
== NULL
|| mci
->mci_host
== NULL
)
799 /* Already have the persistent information in memory */
800 if (SingleThreadDelivery
&& mci
->mci_statfile
!= NULL
)
804 sm_dprintf("mci_load_persistent: Attempting to load persistent information for %s\n",
807 if (mci_generate_persistent_path(mci
->mci_host
, fname
, sizeof fname
,
810 /* Not much we can do if the file isn't there... */
812 sm_dprintf("mci_load_persistent: Couldn't generate host path\n");
816 fp
= safefopen(fname
, O_RDONLY
, FileMode
,
817 SFF_NOLOCK
|SFF_NOLINK
|SFF_OPENASROOT
|SFF_REGONLY
|SFF_SAFEDIRPATH
);
820 /* I can't think of any reason this should ever happen */
822 sm_dprintf("mci_load_persistent: open(%s): %s\n",
823 fname
, sm_errstring(errno
));
828 locked
= lockfile(sm_io_getinfo(fp
, SM_IO_WHAT_FD
, NULL
), fname
, "",
832 (void) mci_read_persistent(fp
, mci
);
833 (void) lockfile(sm_io_getinfo(fp
, SM_IO_WHAT_FD
, NULL
), fname
,
837 (void) sm_io_close(fp
, SM_TIME_DEFAULT
);
844 ** MCI_READ_PERSISTENT -- read persistent host status file
847 ** fp -- the file pointer to read.
848 ** mci -- the pointer to fill in.
851 ** -1 -- if the file was corrupt.
855 ** This code makes the assumption that this data
856 ** will be read in an atomic fashion, and that the data
857 ** was written in an atomic fashion. Any other functioning
858 ** may lead to some form of insanity. This should be
859 ** perfectly safe due to underlying stdio buffering.
863 mci_read_persistent(fp
, mci
)
869 int saveLineNumber
= LineNumber
;
873 syserr("mci_read_persistent: NULL fp");
875 syserr("mci_read_persistent: NULL mci");
878 sm_dprintf("mci_read_persistent: fp=%lx, mci=",
882 SM_FREE_CLR(mci
->mci_status
);
883 SM_FREE_CLR(mci
->mci_rstatus
);
885 sm_io_rewind(fp
, SM_TIME_DEFAULT
);
888 while (sm_io_fgets(fp
, SM_TIME_DEFAULT
, buf
, sizeof buf
) != NULL
)
891 p
= strchr(buf
, '\n');
896 case 'V': /* version stamp */
898 if (ver
< 0 || ver
> 0)
899 syserr("Unknown host status version %d: %d max",
903 case 'E': /* UNIX error number */
904 mci
->mci_errno
= atoi(&buf
[1]);
907 case 'H': /* DNS error number */
908 mci
->mci_herrno
= atoi(&buf
[1]);
911 case 'S': /* UNIX exit status */
912 mci
->mci_exitstat
= atoi(&buf
[1]);
915 case 'D': /* DSN status */
916 mci
->mci_status
= newstr(&buf
[1]);
919 case 'R': /* SMTP status */
920 mci
->mci_rstatus
= newstr(&buf
[1]);
923 case 'U': /* last usage time */
924 mci
->mci_lastuse
= atol(&buf
[1]);
927 case '.': /* end of file */
929 mci_dump(mci
, false);
933 sm_syslog(LOG_CRIT
, NOQID
,
934 "%s: line %d: Unknown host status line \"%s\"",
935 FileName
== NULL
? mci
->mci_host
: FileName
,
937 LineNumber
= saveLineNumber
;
941 LineNumber
= saveLineNumber
;
943 sm_dprintf("incomplete (missing dot for EOF)\n");
949 ** MCI_STORE_PERSISTENT -- Store persistent MCI information
951 ** Store information about host that is kept
952 ** in common for all running sendmails.
955 ** mci -- the host/connection to store persistent info for.
962 mci_store_persistent(mci
)
965 int save_errno
= errno
;
970 sm_dprintf("mci_store_persistent: NULL mci\n");
974 if (HostStatDir
== NULL
|| mci
->mci_host
== NULL
)
978 sm_dprintf("mci_store_persistent: Storing information for %s\n",
981 if (mci
->mci_statfile
== NULL
)
984 sm_dprintf("mci_store_persistent: no statfile\n");
988 sm_io_rewind(mci
->mci_statfile
, SM_TIME_DEFAULT
);
990 (void) ftruncate(sm_io_getinfo(mci
->mci_statfile
, SM_IO_WHAT_FD
, NULL
),
992 #endif /* !NOFTRUNCATE */
994 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, "V0\n");
995 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, "E%d\n",
997 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, "H%d\n",
999 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, "S%d\n",
1001 if (mci
->mci_status
!= NULL
)
1002 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
,
1004 denlstring(mci
->mci_status
, true, false));
1005 if (mci
->mci_rstatus
!= NULL
)
1006 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
,
1008 denlstring(mci
->mci_rstatus
, true, false));
1009 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, "U%ld\n",
1010 (long)(mci
->mci_lastuse
));
1011 (void) sm_io_fprintf(mci
->mci_statfile
, SM_TIME_DEFAULT
, ".\n");
1013 (void) sm_io_flush(mci
->mci_statfile
, SM_TIME_DEFAULT
);
1019 ** MCI_TRAVERSE_PERSISTENT -- walk persistent status tree
1021 ** Recursively find all the mci host files in `pathname'. Default to
1022 ** main host status directory if no path is provided.
1023 ** Call (*action)(pathname, host) for each file found.
1025 ** Note: all information is collected in a list before it is processed.
1026 ** This may not be the best way to do it, but it seems safest, since
1027 ** the file system would be touched while we are attempting to traverse
1028 ** the directory tree otherwise (during purges).
1031 ** action -- function to call on each node. If returns < 0,
1032 ** return immediately.
1033 ** pathname -- root of tree. If null, use main host status
1037 ** < 0 -- if any action routine returns a negative value, that
1038 ** value is returned.
1039 ** 0 -- if we successfully went to completion.
1040 ** > 0 -- return status from action()
1044 mci_traverse_persistent(action
, pathname
)
1048 struct stat statbuf
;
1052 if (pathname
== NULL
)
1053 pathname
= HostStatDir
;
1054 if (pathname
== NULL
)
1058 sm_dprintf("mci_traverse: pathname is %s\n", pathname
);
1060 ret
= stat(pathname
, &statbuf
);
1064 sm_dprintf("mci_traverse: Failed to stat %s: %s\n",
1065 pathname
, sm_errstring(errno
));
1068 if (S_ISDIR(statbuf
.st_mode
))
1070 bool leftone
, removedone
;
1074 char newpath
[MAXPATHLEN
];
1076 if ((d
= opendir(pathname
)) == NULL
)
1079 sm_dprintf("mci_traverse: opendir %s: %s\n",
1080 pathname
, sm_errstring(errno
));
1083 len
= sizeof(newpath
) - MAXNAMLEN
- 3;
1084 if (sm_strlcpy(newpath
, pathname
, len
) >= len
)
1087 sm_dprintf("mci_traverse: path \"%s\" too long",
1091 newptr
= newpath
+ strlen(newpath
);
1095 ** repeat until no file has been removed
1096 ** this may become ugly when several files "expire"
1097 ** during these loops, but it's better than doing
1098 ** a rewinddir() inside the inner loop
1103 leftone
= removedone
= false;
1104 while ((e
= readdir(d
)) != NULL
)
1106 if (e
->d_name
[0] == '.')
1109 (void) sm_strlcpy(newptr
, e
->d_name
,
1111 (newptr
- newpath
));
1115 ret
= mci_traverse_persistent(action
, newpath
);
1120 if (!removedone
&& ret
== 0 &&
1121 action
== mci_purge_persistent
)
1128 ** The following appears to be
1129 ** necessary during purges, since
1130 ** we modify the directory structure
1136 sm_dprintf("mci_traverse: path %s: ret %d removed %d left %d\n",
1137 pathname
, ret
, removedone
, leftone
);
1138 } while (removedone
);
1140 /* purge (or whatever) the directory proper */
1144 ret
= (*action
)(newpath
, NULL
);
1148 else if (S_ISREG(statbuf
.st_mode
))
1150 char *end
= pathname
+ strlen(pathname
) - 1;
1153 char host
[MAXHOSTNAMELEN
];
1154 char *hostptr
= host
;
1157 ** Reconstruct the host name from the path to the
1158 ** persistent information.
1163 if (hostptr
!= host
)
1166 while (start
> pathname
&& *(start
- 1) != '/')
1172 for (scan
= start
; scan
<= end
; scan
++)
1173 *(hostptr
++) = *scan
;
1176 } while (end
> pathname
&& *end
== '.');
1181 ** Do something with the file containing the persistent
1185 ret
= (*action
)(pathname
, host
);
1191 ** MCI_PRINT_PERSISTENT -- print persistent info
1193 ** Dump the persistent information in the file 'pathname'
1196 ** pathname -- the pathname to the status file.
1197 ** hostname -- the corresponding host name.
1204 mci_print_persistent(pathname
, hostname
)
1208 static bool initflag
= false;
1210 int width
= Verbose
? 78 : 25;
1214 /* skip directories */
1215 if (hostname
== NULL
)
1224 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
,
1225 " -------------- Hostname --------------- How long ago ---------Results---------\n");
1228 fp
= safefopen(pathname
, O_RDONLY
, FileMode
,
1229 SFF_NOLOCK
|SFF_NOLINK
|SFF_OPENASROOT
|SFF_REGONLY
|SFF_SAFEDIRPATH
);
1234 sm_dprintf("mci_print_persistent: cannot open %s: %s\n",
1235 pathname
, sm_errstring(errno
));
1239 FileName
= pathname
;
1240 memset(&mcib
, '\0', sizeof mcib
);
1241 if (mci_read_persistent(fp
, &mcib
) < 0)
1243 syserr("%s: could not read status file", pathname
);
1244 (void) sm_io_close(fp
, SM_TIME_DEFAULT
);
1249 locked
= !lockfile(sm_io_getinfo(fp
, SM_IO_WHAT_FD
, NULL
), pathname
,
1250 "", LOCK_SH
|LOCK_NB
);
1251 (void) sm_io_close(fp
, SM_TIME_DEFAULT
);
1254 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "%c%-39s %12s ",
1255 locked
? '*' : ' ', hostname
,
1256 pintvl(curtime() - mcib
.mci_lastuse
, true));
1257 if (mcib
.mci_rstatus
!= NULL
)
1258 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "%.*s\n", width
,
1260 else if (mcib
.mci_exitstat
== EX_TEMPFAIL
&& mcib
.mci_errno
!= 0)
1261 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
,
1262 "Deferred: %.*s\n", width
- 10,
1263 sm_errstring(mcib
.mci_errno
));
1264 else if (mcib
.mci_exitstat
!= 0)
1266 char *exmsg
= sm_sysexmsg(mcib
.mci_exitstat
);
1272 (void) sm_snprintf(buf
, sizeof buf
,
1273 "Unknown mailer error %d",
1275 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "%.*s\n",
1279 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "%.*s\n",
1282 else if (mcib
.mci_errno
== 0)
1283 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "OK\n");
1285 (void) sm_io_fprintf(smioout
, SM_TIME_DEFAULT
, "OK: %.*s\n",
1286 width
- 4, sm_errstring(mcib
.mci_errno
));
1291 ** MCI_PURGE_PERSISTENT -- Remove a persistence status file.
1294 ** pathname -- path to the status file.
1295 ** hostname -- name of host corresponding to that file.
1296 ** NULL if this is a directory (domain).
1300 ** 1 -- file not deleted (too young, incorrect format)
1301 ** < 0 -- some error occurred
1305 mci_purge_persistent(pathname
, hostname
)
1309 struct stat statbuf
;
1310 char *end
= pathname
+ strlen(pathname
) - 1;
1314 sm_dprintf("mci_purge_persistent: purging %s\n", pathname
);
1316 ret
= stat(pathname
, &statbuf
);
1320 sm_dprintf("mci_purge_persistent: Failed to stat %s: %s\n",
1321 pathname
, sm_errstring(errno
));
1324 if (curtime() - statbuf
.st_mtime
<= MciInfoTimeout
)
1326 if (hostname
!= NULL
)
1328 /* remove the file */
1329 ret
= unlink(pathname
);
1333 sm_syslog(LOG_ERR
, NOQID
,
1334 "mci_purge_persistent: failed to unlink %s: %s",
1335 pathname
, sm_errstring(errno
));
1337 sm_dprintf("mci_purge_persistent: failed to unlink %s: %s\n",
1338 pathname
, sm_errstring(errno
));
1344 /* remove the directory */
1349 sm_dprintf("mci_purge_persistent: dpurge %s\n", pathname
);
1351 ret
= rmdir(pathname
);
1355 sm_dprintf("mci_purge_persistent: rmdir %s: %s\n",
1356 pathname
, sm_errstring(errno
));
1364 ** MCI_GENERATE_PERSISTENT_PATH -- generate path from hostname
1366 ** Given `host', convert from a.b.c to $HostStatDir/c./b./a,
1367 ** putting the result into `path'. if `createflag' is set, intervening
1368 ** directories will be created as needed.
1371 ** host -- host name to convert from.
1372 ** path -- place to store result.
1373 ** pathlen -- length of path buffer.
1374 ** createflag -- if set, create intervening directories as
1383 mci_generate_persistent_path(host
, path
, pathlen
, createflag
)
1389 char *elem
, *p
, *x
, ch
;
1392 char t_host
[MAXHOSTNAMELEN
];
1394 struct in6_addr in6_addr
;
1395 #endif /* NETINET6 */
1398 ** Rationality check the arguments.
1403 syserr("mci_generate_persistent_path: null host");
1408 syserr("mci_generate_persistent_path: null path");
1413 sm_dprintf("mci_generate_persistent_path(%s): ", host
);
1415 if (*host
== '\0' || *host
== '.')
1418 /* make certain this is not a bracketed host number */
1419 if (strlen(host
) > sizeof t_host
- 1)
1422 (void) sm_strlcpy(t_host
, host
+ 1, sizeof t_host
);
1424 (void) sm_strlcpy(t_host
, host
, sizeof t_host
);
1427 ** Delete any trailing dots from the hostname.
1428 ** Leave 'elem' pointing at the \0.
1431 elem
= t_host
+ strlen(t_host
);
1432 while (elem
> t_host
&&
1433 (elem
[-1] == '.' || (host
[0] == '[' && elem
[-1] == ']')))
1436 /* check for bogus bracketed address */
1441 if (anynet_pton(AF_INET6
, t_host
, &in6_addr
) == 1)
1443 # endif /* NETINET6 */
1445 if (inet_addr(t_host
) != INADDR_NONE
)
1447 # endif /* NETINET */
1452 /* check for what will be the final length of the path */
1453 len
= strlen(HostStatDir
) + 2;
1454 for (p
= (char *) t_host
; *p
!= '\0'; p
++)
1459 if (p
[0] == '.' && p
[1] == '.')
1462 if (len
> pathlen
|| len
< 1)
1464 (void) sm_strlcpy(path
, HostStatDir
, pathlen
);
1465 p
= path
+ strlen(path
);
1466 while (elem
> t_host
)
1468 if (!path_is_dir(path
, createflag
))
1474 while (elem
>= t_host
&& *elem
!= '.')
1478 while ((ch
= *x
++) != '\0' && ch
!= '.')
1480 if (isascii(ch
) && isupper(ch
))
1483 ch
= ':'; /* / -> : */
1493 sm_dprintf("FAILURE %d\n", ret
);
1495 sm_dprintf("SUCCESS %s\n", path
);