chiark / gitweb /
f8af279a37693ddabec10495c1ab7ef4d2ddbfd8
[inn-innduct.git] / backends / innduct.c
1 /*
2  *  innduct
3  *  tailing reliable realtime streaming feeder for inn
4  *
5  *  Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
6  * 
7  *  This program is free software: you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation, either version 3 of the License, or
10  *  (at your option) any later version.
11  * 
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  * 
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  *
20  *  (I believe that when you compile and link this as part of the inn2
21  *  build, with the Makefile runes I have provided, all the libraries
22  *  and files which end up included in innduct are licence-compatible
23  *  with GPLv3.  If not then please let me know.  -Ian Jackson.)
24  */
25
26 /*
27  * Newsfeeds file entries should look like this:
28  *     host.name.of.site[/exclude,exclude,...]\
29  *             :pattern,pattern...[/distribution,distribution...]\
30  *             :Tf,Wnm
31  *             :
32  * or
33  *     sitename[/exclude,exclude,...]\
34  *             :pattern,pattern...[/distribution,distribution...]\
35  *             :Tf,Wnm
36  *             :host.name.of.site
37  *
38  * Four files full of
39  *    token messageid
40  * or might be blanked out
41  *    <spc><spc><spc><spc>....
42  *
43  * F site.name                 main feed file
44  *                                opened/created, then written, by innd
45  *                                read by duct
46  *                                unlinked by duct
47  *                                tokens blanked out by duct when processed
48  *   site.name_lock            lock preventing multiple ducts
49  *                                to hold lock must open,F_SETLK[W]
50  *                                  and then stat to check that locked file
51  *                                  still has name site.name_lock
52  *                                holder of this lock is "duct"
53  *                                (only) lockholder may remove the lockfile
54  * D site.name_flushing        temporary feed file during flush (or crash)
55  *                                hardlink created by duct
56  *                                unlinked by duct
57  *   site.name_defer           431'd articles, still being written,
58  *                                created, written, used by duct
59  *
60  *   site.name_backlog.<date>.<inum>
61  *                             431'd articles, ready for innxmit or duct
62  *                                created (link/mv) by duct
63  *   site.name_backlog<anything-else>  (where <anything-else> does not
64  *                                      contain '#' or '~') eg
65  *   site.name_backlog.manual
66  *                             anything the sysadmin likes (eg, feed files
67  *                             from old feeds to be merged into this one)
68  *                                created (link/mv) by admin
69  *                                may be symlinks (in which case links
70  *                                may be written through, but only links
71  *                                will be removed.
72  *
73  *                             It is safe to remove backlog files manually,
74  *                             if it's desired to throw away the backlog.
75  *
76  * Backlog files are also processed by innduct.  We find the oldest
77  * backlog file which is at least a certain amount old, and feed it
78  * back into our processing.  When every article in it has been read
79  * and processed, we unlink it and look for another backlog file.
80  *
81  * If we don't have a backlog file that we're reading, we close the
82  * defer file that we're writing and make it into a backlog file at
83  * the first convenient opportunity.
84  * -8<-
85
86
87    OVERALL STATES:
88
89                                                                 START
90                                                                   |
91      ,-->--.                                                 check F, D
92      |     |                                                      |
93      |     |                                                      |
94      |     |  <----------------<---------------------------------'|
95      |     |                                       F exists       |
96      |     |                                       D ENOENT       |
97      |     |  duct opens F                                        |
98      |     V                                                      |
99      |  Normal                                                    |
100      |   F: innd writing, duct reading                            |
101      |   D: ENOENT                                                |
102      |     |                                                      |
103      |     |  duct decides time to flush                          |
104      |     |  duct makes hardlink                                 |
105      |     |                                                      |
106      |     V                            <------------------------'|
107      |  Hardlinked                                  F==D          |
108      |   F == D: innd writing, duct reading         both exist    |
109      ^     |                                                      |
110      |     |  duct unlinks F                                      |
111      |     |                        <-----------<-------------<--'|
112      |     |                           open D         F ENOENT    |
113      |     |                           if exists                  |
114      |     |                                                      |
115      |     V                        <---------------------.       |
116      |  Moved                                             |       |
117      |   F: ENOENT                                        |       |
118      |   D: innd writing, duct reading; or ENOENT         |       |
119      |     |                                              |       |
120      |     |  duct requests flush of feed                 |       |
121      |     |   (others can too, harmlessly)               |       |
122      |     V                                              |       |
123      |  Flushing                                          |       |
124      |   F: ENOENT                                        |       |
125      |   D: innd flushing, duct; or ENOENT                |       |
126      |     |                                              |       |
127      |     |   inndcomm flush fails                       |       |
128      |     |`-------------------------->------------------'       |
129      |     |                                                      |
130      |     |   inndcomm reports no such site                      |
131      |     |`---------------------------------------------------- | -.
132      |     |                                                      |  |
133      |     |  innd finishes writing D, creates F                  |  |
134      |     |  inndcomm reports flush successful                   |  |
135      |     |                                                      |  |
136      |     V                                                      |  |
137      |  Separated                                <----------------'  |
138      |   F: innd writing                            F!=D             /
139      |   D: duct reading; or ENOENT                  both exist     /
140      |     |                                                       /
141      |     |  duct gets to the end of D                           /
142      |     |  duct opens F too                                   /
143      |     V                                                    /
144      |  Finishing                                              /
145      |   F: innd writing, duct reading                        |
146      |   D: duct finishing                                    V
147      |     |                                            Dropping
148      |     |  duct finishes processing D                 F: ENOENT
149      |     V  duct unlinks D                             D: duct reading
150      |     |                                                  |
151      `--<--'                                                  | duct finishes
152                                                               |  processing D
153                                                               | duct unlinks D
154                                                               | duct exits
155                                                               V
156                                                         Dropped
157                                                          F: ENOENT
158                                                          D: ENOENT
159                                                          duct not running
160
161    "duct reading" means innduct is reading the file but also
162    overwriting processed tokens.
163
164  * ->8- -^L-
165  *
166  * rune for printing diagrams:
167
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
169
170  *
171  */
172
173 /*============================== PROGRAM ==============================*/
174
175 #define _GNU_SOURCE 1
176
177 #include "config.h"
178 #include "storage.h"
179 #include "nntp.h"
180 #include "libinn.h"
181 #include "inndcomm.h"
182
183 #include "inn/list.h"
184 #include "inn/innconf.h"
185
186 #include <sys/uio.h>
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
191 #include <sys/un.h>
192 #include <unistd.h>
193 #include <string.h>
194 #include <signal.h>
195 #include <stdio.h>
196 #include <errno.h>
197 #include <syslog.h>
198 #include <fcntl.h>
199 #include <stdarg.h>
200 #include <assert.h>
201 #include <stdlib.h>
202 #include <stddef.h>
203 #include <glob.h>
204 #include <time.h>
205 #include <math.h>
206 #include <ctype.h>
207
208 #include <oop.h>
209 #include <oop-read.h>
210
211 /*----- general definitions, probably best not changed -----*/
212
213 #define CONNCHILD_ESTATUS_STREAM   24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
215
216 #define INNDCOMMCHILD_ESTATUS_FAIL     26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
218
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CLI_COMMAND 1000
221
222 #define VA                va_list al;  va_start(al,fmt)
223 #define PRINTF(f,a)       __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET             __attribute__((__noreturn__))
226
227 #define NEW(ptr)              ((ptr)= zxmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
229
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
231
232 #define FOR_CONN(conn) \
233   for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
234
235 /*----- doubly linked lists -----*/
236
237 #define ISNODE(T)   struct node list_node
238 #define DEFLIST(T)                              \
239    typedef struct {                             \
240      union { struct list li; T *for_type; } u;  \
241      int count;                                 \
242    } T##List
243
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
245
246 #define LIST_CHECKCANHAVENODE(l,n) \
247   ((void)((n) == ((l).u.for_type))) /* just for the type check */
248
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow)    \
250  ( LIST_CHECKCANHAVENODE(l,n),                  \
251    list_addsomehow(&(l).u.li, NODE((n))),       \
252    (void)(l).count++                            \
253    )
254
255 #define LIST_REMSOMEHOW(l,list_remsomehow)      \
256  ( (typeof((l).u.for_type))                     \
257    ( (l).count                                  \
258      ? ( (l).count--,                           \
259          list_remsomehow(&(l).u.li) )           \
260      : 0                                        \
261      )                                          \
262    )
263
264
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
269
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
274
275 #define LIST_REMOVE(l,n)                        \
276  ( LIST_CHECKCANHAVENODE(l,n),                  \
277    list_remove(NODE((n))),                      \
278    (void)(l).count--                            \
279    )
280
281 #define LIST_INSERT(l,n,pred)                                   \
282  ( LIST_CHECKCANHAVENODE(l,n),                                  \
283    LIST_CHECKCANHAVENODE(l,pred),                               \
284    list_insert((struct list*)&(l), NODE((n)), NODE((pred))),    \
285    (void)(l).count++                                            \
286    )
287
288 /*----- type predeclarations -----*/
289
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct CliCommand CliCommand;
297
298 DEFLIST(Conn);
299 DEFLIST(Article);
300
301 /*----- function predeclarations -----*/
302
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
306
307 static void xmit_free(XmitDetails *d);
308
309 #define SMS(newstate, periods, why) \
310    (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312                              const char *forlog, const char *why);
313
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(const char *why /* 0 means timeout */);
317                                   /* => Flushing,FLUSHING, ret 1; or ret 0 */
318
319 static void article_done(Article *art, int whichcount);
320
321 static void check_assign_articles(void);
322 static void queue_check_input_done(void);
323 static void check_reading_pause_resume(InputFile *ipf);
324
325 static void statemc_check_flushing_done(void);
326 static void statemc_check_backlog_done(void);
327
328 static void postfork(void);
329 static void period(void);
330
331 static void open_defer(void);
332 static void close_defer(void);
333 static void search_backlog_file(void);
334 static void preterminate(void);
335 static void raise_default(int signo) NORET;
336 static char *debug_report_ipf(InputFile *ipf);
337
338 static void inputfile_reading_start(InputFile *ipf);
339 static void inputfile_reading_stop(InputFile *ipf);
340 static void inputfile_reading_pause(InputFile *ipf);
341 static void inputfile_reading_resume(InputFile *ipf);
342   /* pause and resume are idempotent, and no-op if not done _reading_start */
343
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void tailing_make_readable(InputFile *ipf);
347
348 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
349 static void connfail(Conn *conn, const char *fmt, ...)         PRINTF(2,3);
350
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
353
354
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
357
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_run, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int become_daemon=1, try_filemon=1;
362 static int try_stream=1;
363 static int port=119;
364 static const char *inndconffile;
365
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=60;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
372
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
375
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
378
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=100;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387
388 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
389 static int max_bad_data_initial= 30;
390   /* in one corrupt 4096-byte block the number of newlines has
391    * mean 16 and standard deviation 3.99.  30 corresponds to z=+3.5 */
392
393
394 /*----- statistics -----*/
395
396 typedef enum {      /* in queue                 in conn->sent             */
397   art_Unchecked,    /*   not checked, not sent    checking                */
398   art_Wanted,       /*   checked, wanted          sent body as requested  */
399   art_Unsolicited,  /*   -                        sent body without check */
400   art_MaxState,
401 } ArtState;
402
403 static const char *const artstate_names[]=
404   { "Unchecked", "Wanted", "Unsolicited", 0 };
405
406 #define RESULT_COUNTS(RCS,RCN)                  \
407   RCS(sent)                                     \
408   RCS(accepted)                                 \
409   RCN(unwanted)                                 \
410   RCN(rejected)                                 \
411   RCN(deferred)                                 \
412   RCN(missing)                                  \
413   RCN(connretry)
414
415 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
416 #define RCI_TRIPLE_VALS_BASE(counts,x)          \
417        counts[art_Unchecked] x                  \
418        + counts[art_Wanted] x                   \
419        + counts[art_Unsolicited] x,             \
420        counts[art_Unchecked] x                  \
421        , counts[art_Wanted] x                   \
422        , counts[art_Unsolicited] x
423
424 typedef enum {
425 #define RC_INDEX(x) RC_##x,
426   RESULT_COUNTS(RC_INDEX, RC_INDEX)
427   RCI_max
428 } ResultCountIndex;
429
430
431 /*----- transmission buffers -----*/
432
433 #define CONNIOVS 128
434
435 typedef enum {
436   xk_Const, xk_Artdata
437 } XmitKind;
438
439 struct XmitDetails {
440   XmitKind kind;
441   union {
442     ARTHANDLE *sm_art;
443   } info;
444 };
445
446
447 /*----- core operational data structure types -----*/
448
449 struct InputFile {
450   /* This is also an instance of struct oop_readable */
451   struct oop_readable readable; /* first */
452   oop_readable_call *readable_callback;
453   void *readable_callback_user;
454
455   int fd;
456   Filemon_Perfile *filemon;
457
458   oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
459   off_t offset;
460   int skippinglong, paused, fake_readable;
461
462   ArticleList queue;
463   long inprogress; /* includes queue.count and also articles in conns */
464   long autodefer; /* -1 means not doing autodefer */
465
466   int counts[art_MaxState][RCI_max];
467   int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
468   char path[];
469 };
470
471 struct Article {
472   ISNODE(Article);
473   ArtState state;
474   int midlen, missing;
475   InputFile *ipf;
476   TOKEN token;
477   off_t offset;
478   int blanklen;
479   char messageid[1];
480 };
481
482 #define SMS_LIST(X)                             \
483   X(NORMAL)                                     \
484   X(FLUSHING)                                   \
485   X(FLUSHFAILED)                                \
486   X(SEPARATED)                                  \
487   X(DROPPING)                                   \
488   X(DROPPED)
489
490 enum StateMachineState {
491 #define SMS_DEF_ENUM(s) sm_##s,
492   SMS_LIST(SMS_DEF_ENUM)
493 };
494
495 static const char *sms_names[]= {
496 #define SMS_DEF_NAME(s) #s ,
497   SMS_LIST(SMS_DEF_NAME)
498   0
499 };
500
501 struct Conn {
502   ISNODE(Conn);
503   int fd; /* may be 0, meaning closed (during construction/destruction) */
504   oop_read *rd; /* likewise */
505   int max_queue, stream, quitting;
506   int since_activity; /* periods */
507   ArticleList waiting; /* not yet told peer */
508   ArticleList priority; /* peer says send it now */
509   ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
510   struct iovec xmit[CONNIOVS];
511   XmitDetails xmitd[CONNIOVS];
512   int xmitu;
513 };
514
515
516 /*----- general operational variables -----*/
517
518 /* main initialises */
519 static oop_source *loop;
520 static ConnList conns;
521 static char *path_lock, *path_flushing, *path_defer, *path_dump;
522 static char *globpat_backlog;
523 static pid_t self_pid;
524
525 /* statemc_init initialises */
526 static StateMachineState sms;
527 static int until_flush;
528 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
529 static FILE *defer;
530
531 /* initialisation to 0 is good */
532 static int until_connect, until_backlog_nextscan;
533 static double accept_proportion;
534 static int nocheck, nocheck_reported, in_child;
535
536 /* for simulation, debugging, etc. */
537 int simulate_flush= -1;
538
539 /*========== logging ==========*/
540
541 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
542 static void logcore(int sysloglevel, const char *fmt, ...) {
543   VA;
544   if (become_daemon) {
545     vsyslog(sysloglevel,fmt,al);
546   } else {
547     if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
548     vfprintf(stderr,fmt,al);
549     putc('\n',stderr);
550   }
551   va_end(al);
552 }
553
554 static void logv(int sysloglevel, const char *pfx, int errnoval,
555                  const char *fmt, va_list al) PRINTF(5,0);
556 static void logv(int sysloglevel, const char *pfx, int errnoval,
557                  const char *fmt, va_list al) {
558   char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
559   vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
560   msgbuf[sizeof(msgbuf)-1]= 0;
561
562   if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
563     sysloglevel= LOG_ERR; /* run by wrong user, probably */
564
565   logcore(sysloglevel, "<%s>%s: %s%s%s",
566          sitename, pfx, msgbuf,
567          errnoval>=0 ? ": " : "",
568          errnoval>=0 ? strerror(errnoval) : "");
569 }
570
571 #define diewrap(fn, pfx, sysloglevel, err, estatus)             \
572   static void fn(const char *fmt, ...) NORET_PRINTF(1,2);       \
573   static void fn(const char *fmt, ...) {                        \
574     preterminate();                                             \
575     VA;                                                         \
576     logv(sysloglevel, pfx, err, fmt, al);                       \
577     exit(estatus);                                              \
578   }
579
580 #define logwrap(fn, pfx, sysloglevel, err)              \
581   static void fn(const char *fmt, ...) PRINTF(1,2);     \
582   static void fn(const char *fmt, ...) {                \
583     VA;                                                 \
584     logv(sysloglevel, pfx, err, fmt, al);               \
585     va_end(al);                                         \
586   }
587
588 diewrap(sysdie,   " critical", LOG_CRIT,    errno, 16);
589 diewrap(die,      " critical", LOG_CRIT,    -1,    16);
590
591 diewrap(sysfatal, " fatal",    LOG_ERR,     errno, 12);
592 diewrap(fatal,    " fatal",    LOG_ERR,     -1,    12);
593
594 logwrap(syswarn,  " warning",  LOG_WARNING, errno);
595 logwrap(warn,     " warning",  LOG_WARNING, -1);
596
597 logwrap(notice,   " notice",   LOG_NOTICE,  -1);
598 logwrap(info,     " info",     LOG_INFO,    -1);
599 logwrap(debug,    " debug",    LOG_DEBUG,   -1);
600
601
602 /*========== utility functions etc. ==========*/
603
604 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
605 static char *xvasprintf(const char *fmt, va_list al) {
606   char *str;
607   int rc= vasprintf(&str,fmt,al);
608   if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
609   return str;
610 }
611 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
612 static char *xasprintf(const char *fmt, ...) {
613   VA;
614   char *str= xvasprintf(fmt,al);
615   va_end(al);
616   return str;
617 }
618
619 static int close_perhaps(int *fd) {
620   if (*fd <= 0) return 0;
621   int r= close(*fd);
622   *fd=0;
623   return r;
624 }
625 static void xclose(int fd, const char *what, const char *what2) {
626   int r= close(fd);
627   if (r) sysdie("close %s%s",what,what2?what2:"");
628 }
629 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
630   if (*fd <= 0) return;
631   xclose(*fd,what,what2);
632   *fd=0;
633 }
634
635 static pid_t xfork(const char *what) {
636   pid_t child;
637
638   child= fork();
639   if (child==-1) sysfatal("cannot fork for %s",what);
640   debug("forked %s %ld", what, (unsigned long)child);
641   if (!child) postfork();
642   return child;
643 }
644
645 static void on_fd_read_except(int fd, oop_call_fd callback) {
646   loop->on_fd(loop, fd, OOP_READ,      callback, 0);
647   loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
648 }
649 static void cancel_fd_read_except(int fd) {
650   loop->cancel_fd(loop, fd, OOP_READ);
651   loop->cancel_fd(loop, fd, OOP_EXCEPTION);
652 }
653
654 static void report_child_status(const char *what, int status) {
655   if (WIFEXITED(status)) {
656     int es= WEXITSTATUS(status);
657     if (es)
658       warn("%s: child died with error exit status %d", what, es);
659   } else if (WIFSIGNALED(status)) {
660     int sig= WTERMSIG(status);
661     const char *sigstr= strsignal(sig);
662     const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
663     if (sigstr)
664       warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
665     else
666       warn("%s: child died due to unknown fatal signal %d%s",
667            what, sig, coredump);
668   } else {
669     warn("%s: child died with unknown wait status %d", what,status);
670   }
671 }
672
673 static int xwaitpid(pid_t *pid, const char *what) {
674   int status;
675
676   int r= kill(*pid, SIGKILL);
677   if (r) sysdie("cannot kill %s child", what);
678
679   pid_t got= waitpid(*pid, &status, 0);
680   if (got==-1) sysdie("cannot reap %s child", what);
681   if (got==0) die("cannot reap %s child", what);
682
683   *pid= 0;
684
685   return status;
686 }
687
688 static void *zxmalloc(size_t sz) {
689   void *p= xmalloc(sz);
690   memset(p,0,sz);
691   return p;
692 }
693
694 static void xunlink(const char *path, const char *what) {
695   int r= unlink(path);
696   if (r) sysdie("can't unlink %s %s", path, what);
697 }
698
699 static time_t xtime(void) {
700   time_t now= time(0);
701   if (now==-1) sysdie("time(2) failed");
702   return now;
703 }
704
705 static void xsigaction(int signo, const struct sigaction *sa) {
706   int r= sigaction(signo,sa,0);
707   if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
708 }
709
710 static void xsigsetdefault(int signo) {
711   struct sigaction sa;
712   memset(&sa,0,sizeof(sa));
713   sa.sa_handler= SIG_DFL;
714   xsigaction(signo,&sa);
715 }
716
717 static void xgettimeofday(struct timeval *tv_r) {
718   int r= gettimeofday(tv_r,0);
719   if (r) sysdie("gettimeofday(2) failed");
720 }
721
722 static void xsetnonblock(int fd, int nonblocking) {
723   int errnoval= oop_fd_nonblock(fd, nonblocking);
724   if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
725 }
726
727 static void check_isreg(const struct stat *stab, const char *path,
728                         const char *what) {
729   if (!S_ISREG(stab->st_mode))
730     die("%s %s not a plain file (mode 0%lo)",
731         what, path, (unsigned long)stab->st_mode);
732 }
733
734 static void xfstat(int fd, struct stat *stab_r, const char *what) {
735   int r= fstat(fd, stab_r);
736   if (r) sysdie("could not fstat %s", what);
737 }
738
739 static void xfstat_isreg(int fd, struct stat *stab_r,
740                          const char *path, const char *what) {
741   xfstat(fd, stab_r, what);
742   check_isreg(stab_r, path, what);
743 }
744
745 static void xlstat_isreg(const char *path, struct stat *stab,
746                          int *enoent_r /* 0 means ENOENT is fatal */,
747                          const char *what) {
748   int r= lstat(path, stab);
749   if (r) {
750     if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
751     sysdie("could not lstat %s %s", what, path);
752   }
753   if (enoent_r) *enoent_r= 0;
754   check_isreg(stab, path, what);
755 }
756
757 static int samefile(const struct stat *a, const struct stat *b) {
758   assert(S_ISREG(a->st_mode));
759   assert(S_ISREG(b->st_mode));
760   return (a->st_ino == b->st_ino &&
761           a->st_dev == b->st_dev);
762 }
763
764 static char *sanitise(const char *input, int len) {
765   static char sanibuf[100]; /* returns pointer to this buffer! */
766
767   const char *p= input;
768   const char *endp= len>=0 ? input+len : 0;
769   char *q= sanibuf;
770   *q++= '`';
771   for (;;) {
772     if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
773     int c= (!endp || p<endp) ? *p++ : 0;
774     if (!c) { *q++= '\''; *q=0; break; }
775     if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
776     sprintf(q,"\\x%02x",c);
777     q += 4;
778   }
779   return sanibuf;
780 }
781
782 static int isewouldblock(int errnoval) {
783   return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
784 }
785
786 /*========== command and control (CLI) connections ==========*/
787
788 static int cli_master;
789
790 typedef struct CliConn CliConn;
791 struct CliConn {
792   void (*destroy)(CliConn*);
793   int fd;
794   oop_read *rd;
795   FILE *out;
796   union {
797     struct sockaddr sa;
798     struct sockaddr_un un;
799   } sa;
800   socklen_t salen;
801 };
802
803 static const oop_rd_style cli_rd_style= {
804   OOP_RD_DELIM_STRIP, '\n',
805   OOP_RD_NUL_FORBID,
806   OOP_RD_SHORTREC_FORBID
807 };
808
809 static void cli_destroy(CliConn *cc) {
810   cc->destroy(cc);
811 }
812
813 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
814   if (ferror(cc->out) | fflush(cc->out)) {
815     info("CTRL%d write error %s", cc->fd, strerror(errno));
816     cli_destroy(cc);
817   }
818 }
819
820 static void cli_prompt(CliConn *cc /* may destroy*/) {
821   fprintf(cc->out, "%s| ", sitename);
822   cli_checkouterr(cc);
823 }
824
825 struct CliCommand {
826   const char *cmd;
827   void (*f)(CliConn *cc, const CliCommand *ccmd,
828             const char *arg, size_t argsz);
829   void *xdata;
830   int xval;
831 };
832
833 static const CliCommand cli_commands[];
834
835 #define CCMD(wh)                                                \
836   static void ccmd_##wh(CliConn *cc, const CliCommand *c,       \
837                         const char *arg, size_t argsz)
838
839 CCMD(help) {
840   fputs("commands:\n", cc->out);
841   const CliCommand *ccmd;
842   for (ccmd=cli_commands; ccmd->cmd; ccmd++)
843     fprintf(cc->out, " %s\n", ccmd->cmd);
844   fputs("NB: permissible arguments are not shown above."
845         "  Not all commands listed are safe.  See innduct(8).\n", cc->out);
846 }
847
848 CCMD(flush) {
849   int ok= trigger_flush_ok("manual request");
850   if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
851 }
852
853 CCMD(stop) {
854   preterminate();
855   notice("terminating (CTRL%d)",cc->fd);
856   raise_default(SIGTERM);
857   abort();
858 }
859
860 CCMD(dump);
861
862 /* messing with our head: */
863 CCMD(period) { period(); }
864 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
865 CCMD(setint) { *(int*)c->xdata= c->xval; }
866 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
867
868 static const CliCommand cli_commands[]= {
869   { "h",             ccmd_help      },
870   { "flush",         ccmd_flush     },
871   { "stop",          ccmd_stop      },
872   { "dump q",        ccmd_dump, 0,0 },
873   { "dump a",        ccmd_dump, 0,1 },
874
875   { "p",             ccmd_period    },
876
877 #define POKES(cmd,func)                                                 \
878   { cmd "flush",     func,           &until_flush,             1 },     \
879   { cmd "conn",      func,           &until_connect,           0 },     \
880   { cmd "blscan",    func,           &until_backlog_nextscan,  0 },
881 POKES("next ", ccmd_setint)
882 POKES("prod ", ccmd_setint_period)
883
884   { "pretend flush", ccmd_setintarg, &simulate_flush             },
885   { "wedge blscan",  ccmd_setint,    &until_backlog_nextscan, -1 },
886   { 0 }
887 };
888
889 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
890                        const char *errmsg, int errnoval,
891                        const char *data, size_t recsz, void *cc_v) {
892   CliConn *cc= cc_v;
893
894   if (!data) {
895     info("CTRL%d closed", cc->fd);
896     cc->destroy(cc);
897     return OOP_CONTINUE;
898   }
899
900   if (recsz == 0) goto prompt;
901
902   const CliCommand *ccmd;
903   for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
904     int l= strlen(ccmd->cmd);
905     if (recsz < l) continue;
906     if (recsz > l && data[l] != ' ') continue;
907     if (memcmp(data, ccmd->cmd, l)) continue;
908
909     int argl= (int)recsz - (l+1); 
910     ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
911     goto prompt;
912   }
913
914   fputs("unknown command; h for help\n", cc->out);
915
916  prompt:
917   cli_prompt(cc);
918   return OOP_CONTINUE;
919 }
920
921 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
922                         const char *errmsg, int errnoval,
923                         const char *data, size_t recsz, void *cc_v) {
924   CliConn *cc= cc_v;
925   
926   info("CTRL%d read error %s", cc->fd, errmsg);
927   cc->destroy(cc);
928   return OOP_CONTINUE;
929 }
930
931 static int cli_conn_startup(CliConn *cc /* may destroy*/,
932                                 const char *how) {
933   cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
934   if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
935
936   int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
937                       cli_rd_ok, cc,
938                       cli_rd_err, cc);
939   if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
940
941   info("CTRL%d %s ready", cc->fd, how);
942   cli_prompt(cc);
943   return 0;
944 }
945
946 static void cli_stdio_destroy(CliConn *cc) {
947   if (cc->rd) {
948     oop_rd_cancel(cc->rd);
949     errno= oop_rd_delete_tidy(cc->rd);
950     if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
951   }
952   free(cc);
953 }
954
955 static void cli_stdio(void) {
956   NEW_DECL(CliConn *,cc);
957   cc->destroy= cli_stdio_destroy;
958
959   cc->fd= 0;
960   cc->out= stdout;
961   int r= cli_conn_startup(cc,"stdio");
962   if (r) cc->destroy(cc);
963 }
964
965 static void cli_accepted_destroy(CliConn *cc) {
966   if (cc->rd) {
967     oop_rd_cancel(cc->rd);
968     oop_rd_delete_kill(cc->rd);
969   }
970   if (cc->out) { fclose(cc->out); cc->fd=0; }
971   close_perhaps(&cc->fd);
972   free(cc);
973 }
974
975 static void *cli_master_readable(oop_source *lp, int master,
976                                  oop_event ev, void *u) {
977   NEW_DECL(CliConn *,cc);
978   cc->destroy= cli_accepted_destroy;
979
980   cc->salen= sizeof(cc->sa);
981   cc->fd= accept(master, &cc->sa.sa, &cc->salen);
982   if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
983
984   cc->out= fdopen(cc->fd, "w");
985   if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
986
987   int r= cli_conn_startup(cc, "accepted");
988   if (r) goto x;
989
990   return OOP_CONTINUE;
991
992  x:
993   cc->destroy(cc);
994   return OOP_CONTINUE;
995 }
996
997 #define NOCLI(...) do{                                          \
998     syswarn("no cli listener, because failed to " __VA_ARGS__); \
999     goto nocli;                                                 \
1000   }while(0)
1001
1002 static void cli_init(void) {
1003   union {
1004     struct sockaddr sa;
1005     struct sockaddr_un un;
1006   } sa;
1007
1008   memset(&sa,0,sizeof(sa));
1009   int maxlen= sizeof(sa.un.sun_path);
1010
1011   if (!path_cli) {
1012     info("control command line disabled");
1013     return;
1014   }
1015
1016   int pathlen= strlen(path_cli);
1017   if (pathlen > maxlen) {
1018     warn("no cli listener, because cli socket path %s too long (%d>%d)",
1019          path_cli, pathlen, maxlen);
1020     return;
1021   }
1022
1023   if (path_cli_dir) {
1024     int r= mkdir(path_cli_dir, 0700);
1025     if (r && errno!=EEXIST)
1026       NOCLI("create cli socket directory %s", path_cli_dir);
1027   }
1028
1029   int r= unlink(path_cli);
1030   if (r && errno!=ENOENT)
1031     NOCLI("remove old cli socket %s", path_cli);
1032
1033   cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1034   if (cli_master<0) NOCLI("create new cli master socket");
1035
1036   int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1037   sa.un.sun_family= AF_UNIX;
1038   memcpy(sa.un.sun_path, path_cli, pathlen);
1039
1040   r= bind(cli_master, &sa.sa, sl);
1041   if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1042
1043   r= listen(cli_master, 5);
1044   if (r) NOCLI("listen to cli master socket");
1045
1046   xsetnonblock(cli_master, 1);
1047
1048   loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1049   info("cli ready, listening on %s", path_cli);
1050
1051   return;
1052
1053  nocli:
1054   xclose_perhaps(&cli_master, "cli master",0);
1055   return;
1056 }
1057
1058 /*========== management of connections ==========*/
1059
1060 static void conn_closefd(Conn *conn, const char *msgprefix) {
1061   int r= close_perhaps(&conn->fd);
1062   if (r) info("C%d %serror closing socket: %s",
1063               conn->fd, msgprefix, strerror(errno));
1064 }
1065
1066 static void conn_dispose(Conn *conn) {
1067   if (!conn) return;
1068   if (conn->rd) {
1069     oop_rd_cancel(conn->rd);
1070     oop_rd_delete_kill(conn->rd);
1071     conn->rd= 0;
1072   }
1073   if (conn->fd) {
1074     loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1075     loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1076   }
1077   conn_closefd(conn,"");
1078   free(conn);
1079   until_connect= reconnect_delay_periods;
1080 }
1081
1082 static void *conn_exception(oop_source *lp, int fd,
1083                             oop_event ev, void *conn_v) {
1084   Conn *conn= conn_v;
1085   unsigned char ch;
1086   assert(fd == conn->fd);
1087   assert(ev == OOP_EXCEPTION);
1088   int r= read(conn->fd, &ch, 1);
1089   if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1090   else connfail(conn,"exceptional condition on socket (peer sent urgent"
1091                 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1092   return OOP_CONTINUE;
1093 }  
1094
1095 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1096   int requeue[art_MaxState];
1097   memset(requeue,0,sizeof(requeue));
1098
1099   Article *art;
1100   
1101   while ((art= LIST_REMHEAD(conn->priority)))
1102     LIST_ADDTAIL(art->ipf->queue, art);
1103
1104   while ((art= LIST_REMHEAD(conn->waiting)))
1105     LIST_ADDTAIL(art->ipf->queue, art);
1106
1107   while ((art= LIST_REMHEAD(conn->sent))) {
1108     requeue[art->state]++;
1109     if (art->state==art_Unsolicited) art->state= art_Unchecked;
1110     LIST_ADDTAIL(art->ipf->queue,art);
1111     check_reading_pause_resume(art->ipf);
1112   }
1113
1114   int i;
1115   XmitDetails *d;
1116   for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1117     xmit_free(d);
1118
1119   LIST_REMOVE(conns,conn);
1120
1121   char *m= xvasprintf(fmt,al);
1122   warn("C%d[%d] connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1123        conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1124   free(m);
1125
1126   conn_dispose(conn);
1127   check_assign_articles();
1128 }
1129
1130 static void connfail(Conn *conn, const char *fmt, ...) {
1131   va_list al;
1132   va_start(al,fmt);
1133   vconnfail(conn,fmt,al);
1134   va_end(al);
1135 }
1136
1137 static void check_idle_conns(void) {
1138   Conn *conn;
1139   FOR_CONN(conn)
1140     conn->since_activity++;
1141  search_again:
1142   FOR_CONN(conn) {
1143     if (conn->since_activity <= need_activity_periods) continue;
1144
1145     /* We need to shut this down */
1146     if (conn->quitting)
1147       connfail(conn,"timed out waiting for response to QUIT");
1148     else if (conn->sent.count)
1149       connfail(conn,"timed out waiting for responses");
1150     else if (conn->waiting.count || conn->priority.count)
1151       connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1152     else if (conn->xmitu)
1153       connfail(conn,"peer has been sending responses"
1154                " before receiving our commands!");
1155     else {
1156       static const char quitcmd[]= "QUIT\r\n";
1157       int todo= sizeof(quitcmd)-1;
1158       const char *p= quitcmd;
1159       for (;;) {
1160         int r= write(conn->fd, p, todo);
1161         if (r<0) {
1162           if (isewouldblock(errno))
1163             connfail(conn, "blocked writing QUIT to idle connection");
1164           else
1165             connfail(conn, "failed to write QUIT to idle connection: %s",
1166                      strerror(errno));
1167           break;
1168         }
1169         assert(r<=todo);
1170         todo -= r;
1171         if (!todo) {
1172           conn->quitting= 1;
1173           conn->since_activity= 0;
1174           debug("C%d is idle, quitting", conn->fd);
1175           break;
1176         }
1177       }
1178     }
1179     goto search_again;
1180   }
1181 }  
1182
1183 /*---------- making new connections ----------*/
1184
1185 static pid_t connecting_child;
1186 static int connecting_fdpass_sock;
1187
1188 static void connect_attempt_discard(void) {
1189   if (connecting_child) {
1190     int status= xwaitpid(&connecting_child, "connect");
1191     if (!(WIFEXITED(status) ||
1192           (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1193       report_child_status("connect", status);
1194   }
1195   if (connecting_fdpass_sock) {
1196     cancel_fd_read_except(connecting_fdpass_sock);
1197     xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1198   }
1199 }
1200
1201 #define PREP_DECL_MSG_CMSG(msg)                 \
1202   char msgbyte= 0;                              \
1203   struct iovec msgiov;                          \
1204   msgiov.iov_base= &msgbyte;                    \
1205   msgiov.iov_len= 1;                            \
1206   struct msghdr msg;                            \
1207   memset(&msg,0,sizeof(msg));                   \
1208   char msg##cbuf[CMSG_SPACE(sizeof(int))];      \
1209   msg.msg_iov= &msgiov;                         \
1210   msg.msg_iovlen= 1;                            \
1211   msg.msg_control= msg##cbuf;                   \
1212   msg.msg_controllen= sizeof(msg##cbuf);
1213
1214 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1215   Conn *conn= 0;
1216
1217   assert(fd == connecting_fdpass_sock);
1218
1219   PREP_DECL_MSG_CMSG(msg);
1220   
1221   ssize_t rs= recvmsg(fd, &msg, 0);
1222   if (rs<0) {
1223     if (isewouldblock(errno)) return OOP_CONTINUE;
1224     syswarn("failed to read socket from connecting child");
1225     goto x;
1226   }
1227
1228   NEW(conn);
1229   LIST_INIT(conn->waiting);
1230   LIST_INIT(conn->priority);
1231   LIST_INIT(conn->sent);
1232
1233   struct cmsghdr *h= 0;
1234   if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1235   if (!h) {
1236     int status= xwaitpid(&connecting_child, "connect child (broken)");
1237
1238     if (WIFEXITED(status)) {
1239       if (WEXITSTATUS(status) != 0 &&
1240           WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1241           WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1242         /* child already reported the problem */;
1243       else {
1244         if (e == OOP_EXCEPTION)
1245           warn("connect: connection child exited code %d but"
1246                " unexpected exception on fdpass socket",
1247                WEXITSTATUS(status));
1248         else
1249           warn("connect: connection child exited code %d but"
1250                " no cmsg (rs=%d)",
1251                WEXITSTATUS(status), (int)rs);
1252       }
1253     } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1254       warn("connect: connection attempt timed out");
1255     } else {
1256       report_child_status("connect", status);
1257     }
1258     goto x;
1259   }
1260
1261 #define CHK(field, val)                                                  \
1262   if (h->cmsg_##field != val) {                                          \
1263     die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1264         h->cmsg_##field, val);                                           \
1265     goto x;                                                              \
1266   }
1267   CHK(level, SOL_SOCKET);
1268   CHK(type,  SCM_RIGHTS);
1269   CHK(len,   CMSG_LEN(sizeof(conn->fd)));
1270 #undef CHK
1271
1272   if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1273
1274   memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1275
1276   int status;
1277   pid_t got= waitpid(connecting_child, &status, 0);
1278   if (got==-1) sysdie("connect: real wait for child");
1279   assert(got == connecting_child);
1280   connecting_child= 0;
1281
1282   if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1283   int es= WEXITSTATUS(status);
1284   switch (es) {
1285   case CONNCHILD_ESTATUS_STREAM:    conn->stream= 1;   break;
1286   case CONNCHILD_ESTATUS_NOSTREAM:  conn->stream= 0;   break;
1287   default:
1288     fatal("connect: child gave unexpected exit status %d", es);
1289   }
1290
1291   /* Phew! */
1292   conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1293
1294   loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1295   conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1296   if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1297   int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1298                      &peer_rd_ok, conn,
1299                      &peer_rd_err, conn);
1300   if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1301
1302   LIST_ADDHEAD(conns, conn);
1303   notice("C%d[%d] connected %s",
1304          conns.count, conn->fd, conn->stream ? "streaming" : "plain");
1305
1306   connect_attempt_discard();
1307   check_assign_articles();
1308   return OOP_CONTINUE;
1309
1310  x:
1311   conn_dispose(conn);
1312   connect_attempt_discard();
1313   return OOP_CONTINUE;
1314 }
1315
1316 static int allow_connect_start(void) {
1317   return conns.count < max_connections
1318     && !connecting_child
1319     && !until_connect;
1320 }
1321
1322 static void connect_start(void) {
1323   assert(!connecting_child);
1324   assert(!connecting_fdpass_sock);
1325
1326   info("starting connection attempt");
1327
1328   int socks[2];
1329   int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1330   if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1331
1332   connecting_child= xfork("connection");
1333
1334   if (!connecting_child) {
1335     FILE *cn_from, *cn_to;
1336     char buf[NNTP_STRLEN+100];
1337     int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1338
1339     xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1340
1341     alarm(connection_setup_timeout);
1342     if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1343       int l= strlen(buf);
1344       int stripped=0;
1345       while (l>0) {
1346         unsigned char c= buf[l-1];
1347         if (!isspace(c)) break;
1348         if (c=='\n' || c=='\r') stripped=1;
1349         --l;
1350       }
1351       if (!buf[0]) {
1352         sysfatal("connect: connection attempt failed");
1353       } else {
1354         buf[l]= 0;
1355         fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1356               sanitise(buf,-1));
1357       }
1358     }
1359     if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1360       sysfatal("connect: authentication failed");
1361     if (try_stream) {
1362       if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1363           fflush(cn_to))
1364         sysfatal("connect: could not send MODE STREAM");
1365       buf[sizeof(buf)-1]= 0;
1366       if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1367         if (ferror(cn_from))
1368           sysfatal("connect: could not read response to MODE STREAM");
1369         else
1370           fatal("connect: connection close in response to MODE STREAM");
1371       }
1372       int l= strlen(buf);
1373       assert(l>=1);
1374       if (buf[l-1]!='\n')
1375         fatal("connect: response to MODE STREAM is too long: %.100s...",
1376               sanitise(buf,-1));
1377       l--;  if (l>0 && buf[l-1]=='\r') l--;
1378       buf[l]= 0;
1379       char *ep;
1380       int rcode= strtoul(buf,&ep,10);
1381       if (ep != &buf[3])
1382         fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1383
1384       switch (rcode) {
1385       case 203:
1386         exitstatus= CONNCHILD_ESTATUS_STREAM;
1387         break;
1388       case 480:
1389       case 500:
1390         break;
1391       default:
1392         warn("connect: unexpected response to MODE STREAM: %.50s",
1393              sanitise(buf,-1));
1394         exitstatus= 2;
1395         break;
1396       }
1397     }
1398     int fd= fileno(cn_from);
1399
1400     PREP_DECL_MSG_CMSG(msg);
1401     struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1402     cmsg->cmsg_level= SOL_SOCKET;
1403     cmsg->cmsg_type=  SCM_RIGHTS;
1404     cmsg->cmsg_len=   CMSG_LEN(sizeof(fd));
1405     memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1406
1407     msg.msg_controllen= cmsg->cmsg_len;
1408     r= sendmsg(socks[1], &msg, 0);
1409     if (r<0) sysdie("sendmsg failed for new connection");
1410     if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1411
1412     _exit(exitstatus);
1413   }
1414
1415   xclose(socks[1], "connecting fdpass child's socket",0);
1416   connecting_fdpass_sock= socks[0];
1417   xsetnonblock(connecting_fdpass_sock, 1);
1418   on_fd_read_except(connecting_fdpass_sock, connchild_event);
1419 }
1420
1421 /*---------- assigning articles to conns, and transmitting ----------*/
1422
1423 static Article *dequeue_from(int peek, InputFile *ipf) {
1424   if (!ipf) return 0;
1425   if (peek) return LIST_HEAD(ipf->queue);
1426
1427   Article *art= LIST_REMHEAD(ipf->queue);
1428   if (!art) return 0;
1429   check_reading_pause_resume(ipf);
1430   return art;
1431 }
1432
1433 static Article *dequeue(int peek) {
1434   Article *art;
1435   art= dequeue_from(peek, flushing_input_file);  if (art) return art;
1436   art= dequeue_from(peek, backlog_input_file);   if (art) return art;
1437   art= dequeue_from(peek, main_input_file);      if (art) return art;
1438   return 0;
1439 }
1440
1441 static void check_assign_articles(void) {
1442   for (;;) {
1443     if (!dequeue(1))
1444       break;
1445
1446     Conn *walk, *use=0;
1447     int spare=0, inqueue=0;
1448
1449     /* Find a connection to offer this article.  We prefer a busy
1450      * connection to an idle one, provided it's not full.  We take the
1451      * first (oldest) and since that's stable, it will mean we fill up
1452      * connections in order.  That way if we have too many
1453      * connections, the spare ones will go away eventually.
1454      */
1455     FOR_CONN(walk) {
1456       if (walk->quitting) continue;
1457       inqueue= walk->sent.count + walk->priority.count
1458              + walk->waiting.count;
1459       spare= walk->max_queue - inqueue;
1460       assert(inqueue <= max_queue_per_conn);
1461       assert(spare >= 0);
1462       if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1463       else if (spare>0) /*working*/ { use= walk; break; }
1464     }
1465     if (use) {
1466       if (!inqueue) use->since_activity= 0; /* reset idle counter */
1467       while (spare>0) {
1468         Article *art= dequeue(0);
1469         if (!art) break;
1470         LIST_ADDTAIL(use->waiting, art);
1471         spare--;
1472       }
1473       conn_maybe_write(use);
1474     } else if (allow_connect_start()) {
1475       until_connect= reconnect_delay_periods;
1476       connect_start();
1477       break;
1478     } else {
1479       break;
1480     }
1481   }
1482 }
1483
1484 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1485   conn_maybe_write(u);
1486   return OOP_CONTINUE;
1487 }
1488
1489 static void conn_maybe_write(Conn *conn)  {
1490   for (;;) {
1491     conn_make_some_xmits(conn);
1492     if (!conn->xmitu) {
1493       loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1494       return;
1495     }
1496
1497     void *rp= conn_write_some_xmits(conn);
1498     if (rp==OOP_CONTINUE) {
1499       loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1500       return;
1501     } else if (rp==OOP_HALT) {
1502       return;
1503     } else if (!rp) {
1504       /* transmitted everything */
1505     } else {
1506       abort();
1507     }
1508   }
1509 }
1510
1511 /*---------- expiry, flow control and deferral ----------*/
1512
1513 /*
1514  * flow control notes
1515  * to ensure articles go away eventually
1516  * separate queue for each input file
1517  *   queue expiry
1518  *     every period, check head of backlog queue for expiry with SMretrieve
1519  *       if too old: discard, and check next article
1520  *     also check every backlog article as we read it
1521  *   flush expiry
1522  *     after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1523  *     one-off: eat queued articles from flushing and write them to defer
1524  *     one-off: connfail all connections which have any articles from flushing
1525  *     newly read articles from flushing go straight to defer
1526  *     this should take care of it and get us out of this state
1527  * to avoid filling up ram needlessly
1528  *   input control
1529  *     limit number of queued articles for each ipf
1530  *     pause/resume inputfile tailing
1531  */
1532
1533 static void check_reading_pause_resume(InputFile *ipf) {
1534   if (ipf->queue.count >= max_queue_per_ipf)
1535     inputfile_reading_pause(ipf);
1536   else
1537     inputfile_reading_resume(ipf);
1538 }
1539
1540 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1541   open_defer();
1542   if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1543       || fflush(defer))
1544     sysfatal("write to defer file %s",path_defer);
1545   article_done(art, whichcount);
1546 }
1547
1548 static int article_check_expired(Article *art /* must be queued, not conn */) {
1549   ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1550   if (artdata) { SMfreearticle(artdata); return 0; }
1551
1552   LIST_REMOVE(art->ipf->queue, art);
1553   art->missing= 1;
1554   art->ipf->count_nooffer_missing++;
1555   article_done(art,-1);
1556   return 1;
1557 }
1558
1559 static void inputfile_queue_check_expired(InputFile *ipf) {
1560   if (!ipf) return;
1561
1562   for (;;) {
1563     Article *art= LIST_HEAD(ipf->queue);
1564     int exp= article_check_expired(art);
1565     if (!exp) break;
1566   }
1567   check_reading_pause_resume(ipf);
1568 }
1569
1570 static void article_autodefer(InputFile *ipf, Article *art) {
1571   ipf->autodefer++;
1572   article_defer(art,-1);
1573 }
1574
1575 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1576   Article *art;
1577   for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1578     if (art->ipf == ipf) return 1;
1579   return 0;
1580 }
1581
1582 static void autodefer_input_file_articles(InputFile *ipf) {
1583   Article *art;
1584   while ((art= LIST_REMHEAD(ipf->queue)))
1585     article_autodefer(ipf, art);
1586 }
1587
1588 static void autodefer_input_file(InputFile *ipf) {
1589   ipf->autodefer= 0;
1590
1591   autodefer_input_file_articles(ipf);
1592
1593   if (ipf->inprogress) {
1594     Conn *walk;
1595     FOR_CONN(walk) {
1596       if (has_article_in(&walk->waiting,  ipf) ||
1597           has_article_in(&walk->priority, ipf) ||
1598           has_article_in(&walk->sent,     ipf))
1599         walk->quitting= -1;
1600     }
1601     while (ipf->inprogress) {
1602       FOR_CONN(walk)
1603         if (walk->quitting < 0) goto found;
1604       abort(); /* where are they ?? */
1605
1606     found:
1607       connfail(walk, "connection is stuck or crawling,"
1608                " and we need to finish flush");
1609       autodefer_input_file_articles(ipf);
1610     }
1611   }
1612
1613   check_reading_pause_resume(ipf);
1614 }
1615
1616 /*========== article transmission ==========*/
1617
1618 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1619                   XmitKind kind) { /* caller must then fill in details */
1620   struct iovec *v= &conn->xmit[conn->xmitu];
1621   XmitDetails *d= &conn->xmitd[conn->xmitu++];
1622   v->iov_base= (char*)data;
1623   v->iov_len= len;
1624   d->kind= kind;
1625   return d;
1626 }
1627
1628 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1629   xmit_core(conn,data,len, xk_Const);
1630 }
1631 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1632
1633 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1634   XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1635   d->info.sm_art= ah;
1636 }
1637
1638 static void xmit_free(XmitDetails *d) {
1639   switch (d->kind) {
1640   case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1641   case xk_Const:                                  break;
1642   default: abort();
1643   }
1644 }
1645
1646 static void *conn_write_some_xmits(Conn *conn) {
1647   /* return values:
1648    *      0:            nothing more to write, no need to call us again
1649    *      OOP_CONTINUE: more to write but fd not writeable
1650    *      OOP_HALT:     disaster, have destroyed conn
1651    */
1652   for (;;) {
1653     int count= conn->xmitu;
1654     if (!count) return 0;
1655
1656     if (count > IOV_MAX) count= IOV_MAX;
1657     ssize_t rs= writev(conn->fd, conn->xmit, count);
1658     if (rs < 0) {
1659       if (isewouldblock(errno)) return OOP_CONTINUE;
1660       connfail(conn, "write failed: %s", strerror(errno));
1661       return OOP_HALT;
1662     }
1663     assert(rs > 0);
1664
1665     int done;
1666     for (done=0; rs && done<conn->xmitu; done++) {
1667       struct iovec *vp= &conn->xmit[done];
1668       XmitDetails *dp= &conn->xmitd[done];
1669       if (rs > vp->iov_len) {
1670         rs -= vp->iov_len;
1671         xmit_free(dp);
1672       } else {
1673         vp->iov_base= (char*)vp->iov_base + rs;
1674         vp->iov_len -= rs;
1675       }
1676     }
1677     int newu= conn->xmitu - done;
1678     memmove(conn->xmit,  conn->xmit  + done, newu * sizeof(*conn->xmit));
1679     memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1680     conn->xmitu= newu;
1681   }
1682 }
1683
1684 static void conn_make_some_xmits(Conn *conn) {
1685   for (;;) {
1686     if (conn->xmitu+5 > CONNIOVS)
1687       break;
1688
1689     Article *art= LIST_REMHEAD(conn->priority);
1690     if (!art) art= LIST_REMHEAD(conn->waiting);
1691     if (!art) break;
1692
1693     if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1694       /* actually send it */
1695
1696       ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1697
1698       art->state=
1699         art->state == art_Unchecked ? art_Unsolicited :
1700         art->state == art_Wanted    ? art_Wanted      :
1701         (abort(),-1);
1702
1703       if (!artdata) art->missing= 1;
1704       art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1705
1706       if (conn->stream) {
1707         if (artdata) {
1708           XMIT_LITERAL("TAKETHIS ");
1709           xmit_noalloc(conn, art->messageid, art->midlen);
1710           XMIT_LITERAL("\r\n");
1711           xmit_artbody(conn, artdata);
1712         } else {
1713           article_done(art, -1);
1714           continue;
1715         }
1716       } else {
1717         /* we got 235 from IHAVE */
1718         if (artdata) {
1719           xmit_artbody(conn, artdata);
1720         } else {
1721           XMIT_LITERAL(".\r\n");
1722         }
1723       }
1724
1725       LIST_ADDTAIL(conn->sent, art);
1726
1727     } else {
1728       /* check it */
1729
1730       if (conn->stream)
1731         XMIT_LITERAL("CHECK ");
1732       else
1733         XMIT_LITERAL("IHAVE ");
1734       xmit_noalloc(conn, art->messageid, art->midlen);
1735       XMIT_LITERAL("\r\n");
1736
1737       assert(art->state == art_Unchecked);
1738       art->ipf->counts[art->state][RC_sent]++;
1739       LIST_ADDTAIL(conn->sent, art);
1740     }
1741   }
1742 }
1743
1744 /*========== handling responses from peer ==========*/
1745
1746 static const oop_rd_style peer_rd_style= {
1747   OOP_RD_DELIM_STRIP, '\n',
1748   OOP_RD_NUL_FORBID,
1749   OOP_RD_SHORTREC_FORBID
1750 };
1751
1752 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1753                          const char *errmsg, int errnoval,
1754                          const char *data, size_t recsz, void *conn_v) {
1755   Conn *conn= conn_v;
1756   connfail(conn, "error receiving from peer: %s", errmsg);
1757   return OOP_CONTINUE;
1758 }
1759
1760 static Article *article_reply_check(Conn *conn, const char *response,
1761                                     int code_indicates_streaming,
1762                                     int must_have_sent
1763                                         /* 1:yes, -1:no, 0:dontcare */,
1764                                     const char *sanitised_response) {
1765   Article *art= LIST_HEAD(conn->sent);
1766
1767   if (!art) {
1768     connfail(conn,
1769              "peer gave unexpected response when no commands outstanding: %s",
1770              sanitised_response);
1771     return 0;
1772   }
1773
1774   if (code_indicates_streaming) {
1775     assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1776     if (!conn->stream) {
1777       connfail(conn, "peer gave streaming response code "
1778                " to IHAVE or subsequent body: %s", sanitised_response);
1779       return 0;
1780     }
1781     const char *got_mid= response+4;
1782     int got_midlen= strcspn(got_mid, " \n\r");
1783     if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1784       connfail(conn, "peer gave streaming response with syntactically invalid"
1785                " messageid: %s", sanitised_response);
1786       return 0;
1787     }
1788     if (got_midlen != art->midlen ||
1789         memcmp(got_mid, art->messageid, got_midlen)) {
1790       connfail(conn, "peer gave streaming response code to wrong article -"
1791                " probable synchronisation problem; we offered: %s;"
1792                " peer said: %s",
1793                art->messageid, sanitised_response);
1794       return 0;
1795     }
1796   } else {
1797     if (conn->stream) {
1798       connfail(conn, "peer gave non-streaming response code to"
1799                " CHECK/TAKETHIS: %s", sanitised_response);
1800       return 0;
1801     }
1802   }
1803
1804   if (must_have_sent>0 && art->state < art_Wanted) {
1805     connfail(conn, "peer says article accepted but"
1806              " we had not sent the body: %s", sanitised_response);
1807     return 0;
1808   }
1809   if (must_have_sent<0 && art->state >= art_Wanted) {
1810     connfail(conn, "peer says please sent the article but we just did: %s",
1811              sanitised_response);
1812     return 0;
1813   }
1814
1815   Article *art_again= LIST_REMHEAD(conn->sent);
1816   assert(art_again == art);
1817   return art;
1818 }
1819
1820 static void update_nocheck(int accepted) {
1821   accept_proportion *= nocheck_decay;
1822   accept_proportion += accepted * (1.0 - nocheck_decay);
1823   int new_nocheck= accept_proportion >= nocheck_thresh;
1824   if (new_nocheck && !nocheck_reported) {
1825     notice("entering nocheck mode for the first time");
1826     nocheck_reported= 1;
1827   } else if (new_nocheck != nocheck) {
1828     debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1829   }
1830   nocheck= new_nocheck;
1831 }
1832
1833 static void article_done(Article *art, int whichcount) {
1834   if (whichcount>=0 && !art->missing)
1835     art->ipf->counts[art->state][whichcount]++;
1836
1837   if (whichcount == RC_accepted) update_nocheck(1);
1838   else if (whichcount == RC_unwanted) update_nocheck(0);
1839
1840   InputFile *ipf= art->ipf;
1841
1842   while (art->blanklen) {
1843     static const char spaces[]=
1844       "                                                                "
1845       "                                                                "
1846       "                                                                "
1847       "                                                                "
1848       "                                                                "
1849       "                                                                "
1850       "                                                                "
1851       "                                                                "
1852       "                                                                ";
1853     int w= art->blanklen;  if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1854     int r= pwrite(ipf->fd, spaces, w, art->offset);
1855     if (r==-1) {
1856       if (errno==EINTR) continue;
1857       sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1858              art->messageid, art->blanklen,
1859              (unsigned long)art->offset, ipf->path);
1860     }
1861     assert(r>=0 && r<=w);
1862     art->blanklen -= w;
1863     art->offset += w;
1864   }
1865
1866   ipf->inprogress--;
1867   assert(ipf->inprogress >= 0);
1868   free(art);
1869
1870   if (!ipf->inprogress && ipf != main_input_file)
1871     queue_check_input_done();
1872 }
1873
1874 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1875                         const char *errmsg, int errnoval,
1876                         const char *data, size_t recsz, void *conn_v) {
1877   Conn *conn= conn_v;
1878
1879   if (ev == OOP_RD_EOF) {
1880     connfail(conn, "unexpected EOF from peer");
1881     return OOP_CONTINUE;
1882   }
1883   assert(ev == OOP_RD_OK);
1884
1885   char *sani= sanitise(data,-1);
1886
1887   char *ep;
1888   unsigned long code= strtoul(data, &ep, 10);
1889   if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1890     connfail(conn, "badly formatted response from peer: %s", sani);
1891     return OOP_CONTINUE;
1892   }
1893
1894   int conn_busy=
1895     conn->waiting.count ||
1896     conn->priority.count ||
1897     conn->sent.count ||
1898     conn->xmitu;
1899
1900   if (conn->quitting) {
1901     if (code!=205 && code!=503) {
1902       connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1903     } else {
1904       LIST_REMOVE(conns,conn);
1905       notice("C%d[%d] idle connection closed by us", conns.count, conn->fd);
1906       assert(!conn_busy);
1907       conn_dispose(conn);
1908     }
1909     return OOP_CONTINUE;
1910   }
1911
1912   conn->since_activity= 0;
1913   Article *art;
1914
1915 #define GET_ARTICLE(musthavesent) do{                                         \
1916     art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1917     if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */      \
1918   }while(0) 
1919
1920 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{       \
1921     code_streaming= (streaming);                                \
1922     GET_ARTICLE(musthavesent);                                  \
1923     article_done(art, RC_##how);                                \
1924     goto dealtwith;                                             \
1925   }while(0)
1926
1927 #define PEERBADMSG(m) do {                                      \
1928     connfail(conn, m ": %s", sani);  return OOP_CONTINUE;       \
1929   }while(0)
1930
1931   int code_streaming= 0;
1932
1933   switch (code) {
1934
1935   default:  PEERBADMSG("peer sent unexpected message");
1936
1937   case 400:
1938     if (conn_busy)
1939       PEERBADMSG("peer timed us out or stopped accepting articles");
1940
1941     LIST_REMOVE(conns,conn);
1942     notice("C%d[%d] idle connection closed by peer", conns.count, conn->fd);
1943     conn_dispose(conn);
1944     return OOP_CONTINUE;
1945
1946   case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1947   case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1948
1949   case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1950   case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1951
1952   case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1953   case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1954
1955   case 238: /* CHECK says send it */
1956     code_streaming= 1;
1957   case 335: /* IHAVE says send it */
1958     GET_ARTICLE(-1);
1959     assert(art->state == art_Unchecked);
1960     art->ipf->counts[art->state][RC_accepted]++;
1961     art->state= art_Wanted;
1962     LIST_ADDTAIL(conn->priority, art);
1963     break;
1964
1965   case 431: /* CHECK or TAKETHIS says try later */
1966     code_streaming= 1;
1967   case 436: /* IHAVE says try later */
1968     GET_ARTICLE(0);
1969     article_defer(art, RC_deferred);
1970     break;
1971
1972   }
1973 dealtwith:
1974
1975   conn_maybe_write(conn);
1976   check_assign_articles();
1977   return OOP_CONTINUE;
1978 }
1979
1980
1981 /*========== monitoring of input files ==========*/
1982
1983 static void feedfile_eof(InputFile *ipf) {
1984   assert(ipf != main_input_file); /* promised by tailing_try_read */
1985   inputfile_reading_stop(ipf);
1986
1987   if (ipf == flushing_input_file) {
1988     assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1989     if (main_input_file) inputfile_reading_start(main_input_file);
1990     statemc_check_flushing_done();
1991   } else if (ipf == backlog_input_file) {
1992     statemc_check_backlog_done();
1993   } else {
1994     abort(); /* supposed to wait rather than get EOF on main input file */
1995   }
1996 }
1997
1998 static InputFile *open_input_file(const char *path) {
1999   int fd= open(path, O_RDWR);
2000   if (fd<0) {
2001     if (errno==ENOENT) return 0;
2002     sysfatal("unable to open input file %s", path);
2003   }
2004   assert(fd>0);
2005
2006   InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2007   memset(ipf,0,sizeof(*ipf));
2008
2009   ipf->fd= fd;
2010   ipf->autodefer= -1;
2011   LIST_INIT(ipf->queue);
2012   strcpy(ipf->path, path);
2013
2014   return ipf;
2015 }
2016
2017 static void close_input_file(InputFile *ipf) { /* does not free */
2018   assert(!ipf->readable_callback); /* must have had ->on_cancel */
2019   assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2020   assert(!ipf->rd); /* must have had inputfile_reading_stop */
2021   assert(!ipf->inprogress); /* no dangling pointers pointing here */
2022   xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2023 }
2024
2025
2026 /*---------- dealing with articles read in the input file ----------*/
2027
2028 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2029                                    const char *data, const char *how) {
2030   warn("corrupted file: %s, offset %lu: %s: in %s",
2031        ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2032   ipf->readcount_err++;
2033   if (ipf->readcount_err > max_bad_data_initial +
2034       (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2035     die("too much garbage in input file!  (%d errs, %d ok, %d blank)",
2036         ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2037   return OOP_CONTINUE;
2038 }
2039
2040 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2041                                oop_rd_event ev, const char *errmsg,
2042                                int errnoval, const char *data, size_t recsz,
2043                                void *ipf_v) {
2044   InputFile *ipf= ipf_v;
2045   assert(ev == OOP_RD_SYSTEM);
2046   errno= errnoval;
2047   sysdie("error reading input file: %s, offset %lu",
2048          ipf->path, (unsigned long)ipf->offset);
2049 }
2050
2051 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2052                                   oop_rd_event ev, const char *errmsg,
2053                                   int errnoval, const char *data, size_t recsz,
2054                                   void *ipf_v) {
2055   InputFile *ipf= ipf_v;
2056   Article *art;
2057   char tokentextbuf[sizeof(TOKEN)*2+3];
2058
2059   if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2060
2061   off_t old_offset= ipf->offset;
2062   ipf->offset += recsz + !!(ev == OOP_RD_OK);
2063
2064 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2065
2066   if (ev==OOP_RD_PARTREC)
2067     feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2068     /* but process it anyway */
2069
2070   if (ipf->skippinglong) {
2071     if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2072     return OOP_CONTINUE;
2073   }
2074   if (ev==OOP_RD_LONG) {
2075     ipf->skippinglong= 1;
2076     X_BAD_DATA("overly long line");
2077   }
2078
2079   if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2080   if (!recsz) X_BAD_DATA("empty line");
2081
2082   if (data[0]==' ') {
2083     if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2084     ipf->readcount_blank++;
2085     return OOP_CONTINUE;
2086   }
2087
2088   char *space= strchr(data,' ');
2089   int tokenlen= space-data;
2090   int midlen= (int)recsz-tokenlen-1;
2091   if (midlen <= 2) X_BAD_DATA("no room for messageid");
2092   if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2093
2094   if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2095   memcpy(tokentextbuf, data, tokenlen);
2096   tokentextbuf[tokenlen]= 0;
2097   if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2098
2099   ipf->readcount_ok++;
2100
2101   art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2102   memset(art,0,sizeof(*art));
2103   art->state= art_Unchecked;
2104   art->midlen= midlen;
2105   art->ipf= ipf;  ipf->inprogress++;
2106   art->token= TextToToken(tokentextbuf);
2107   art->offset= old_offset;
2108   art->blanklen= recsz;
2109   strcpy(art->messageid, space+1);
2110   LIST_ADDTAIL(ipf->queue, art);
2111
2112   if (ipf->autodefer >= 0)
2113     article_autodefer(ipf, art);
2114   else if (ipf==backlog_input_file)
2115     article_check_expired(art);
2116
2117   if (sms==sm_NORMAL && ipf==main_input_file &&
2118       ipf->offset >= target_max_feedfile_size)
2119     statemc_start_flush("feed file size");
2120
2121   check_assign_articles(); /* may destroy conn but that's OK */
2122   check_reading_pause_resume(ipf);
2123   return OOP_CONTINUE;
2124 }
2125
2126 /*========== tailing input file ==========*/
2127
2128 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2129                                      void *user) {
2130   /* lifetime of ipf here is OK because destruction will cause
2131    * on_cancel which will cancel this callback */
2132   InputFile *ipf= user;
2133
2134   if (!ipf->fake_readable) return OOP_CONTINUE;
2135
2136   /* we just keep calling readable until our caller (oop_rd)
2137    * has called try_read, and try_read has found EOF so given EAGAIN */
2138   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2139
2140   return ipf->readable_callback(loop, &ipf->readable,
2141                                 ipf->readable_callback_user);
2142 }
2143
2144 static void tailing_on_cancel(struct oop_readable *rable) {
2145   InputFile *ipf= (void*)rable;
2146
2147   if (ipf->filemon) filemon_stop(ipf);
2148   loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2149   ipf->readable_callback= 0;
2150 }
2151
2152 static void tailing_make_readable(InputFile *ipf) {
2153   if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2154     return;
2155   ipf->fake_readable= 1;
2156   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2157 }
2158
2159 static int tailing_on_readable(struct oop_readable *rable,
2160                                 oop_readable_call *cb, void *user) {
2161   InputFile *ipf= (void*)rable;
2162
2163   tailing_on_cancel(rable);
2164   ipf->readable_callback= cb;
2165   ipf->readable_callback_user= user;
2166   filemon_start(ipf);
2167   tailing_make_readable(ipf);
2168   return 0;
2169 }
2170
2171 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2172                                 size_t length) {
2173   InputFile *ipf= (void*)rable;
2174   for (;;) {
2175     ssize_t r= read(ipf->fd, buffer, length);
2176     if (r==-1) {
2177       if (errno==EINTR) continue;
2178       ipf->fake_readable= 0;
2179       return r;
2180     }
2181     if (!r) {
2182       if (ipf==main_input_file) {
2183         errno=EAGAIN;
2184         ipf->fake_readable= 0;
2185         return -1;
2186       } else if (ipf==flushing_input_file) {
2187         assert(ipf->rd);
2188         assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2189       } else if (ipf==backlog_input_file) {
2190         assert(ipf->rd);
2191       } else {
2192         abort();
2193       }
2194     }
2195     return r;
2196   }
2197 }
2198
2199 /*---------- filemon implemented with inotify ----------*/
2200
2201 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2202 #define HAVE_FILEMON
2203
2204 #include <sys/inotify.h>
2205
2206 static int filemon_inotify_fd;
2207 static int filemon_inotify_wdmax;
2208 static InputFile **filemon_inotify_wd2ipf;
2209
2210 struct Filemon_Perfile {
2211   int wd;
2212 };
2213
2214 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2215   int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2216   if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2217
2218   if (wd >= filemon_inotify_wdmax) {
2219     int newmax= wd+2;
2220     filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2221                                  sizeof(*filemon_inotify_wd2ipf) * newmax);
2222     memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2223            sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2224     filemon_inotify_wdmax= newmax;
2225   }
2226
2227   assert(!filemon_inotify_wd2ipf[wd]);
2228   filemon_inotify_wd2ipf[wd]= ipf;
2229
2230   debug("filemon inotify startfile %p wd=%d wdmax=%d",
2231         ipf, wd, filemon_inotify_wdmax);
2232
2233   pf->wd= wd;
2234 }
2235
2236 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2237   int wd= pf->wd;
2238   debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2239   int r= inotify_rm_watch(filemon_inotify_fd, wd);
2240   if (r) sysdie("inotify_rm_watch");
2241   filemon_inotify_wd2ipf[wd]= 0;
2242 }
2243
2244 static void *filemon_inotify_readable(oop_source *lp, int fd,
2245                                       oop_event e, void *u) {
2246   struct inotify_event iev;
2247   for (;;) {
2248     int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2249     if (r==-1) {
2250       if (isewouldblock(errno)) break;
2251       sysdie("read from inotify master");
2252     } else if (r==sizeof(iev)) {
2253       assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2254     } else {
2255       die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2256     }
2257     InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2258     /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2259     tailing_make_readable(ipf);
2260   }
2261   return OOP_CONTINUE;
2262 }
2263
2264 static int filemon_method_init(void) {
2265   filemon_inotify_fd= inotify_init();
2266   if (filemon_inotify_fd<0) {
2267     syswarn("filemon/inotify: inotify_init failed");
2268     return 0;
2269   }
2270   xsetnonblock(filemon_inotify_fd, 1);
2271   loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2272
2273   debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2274   return 1;
2275 }
2276
2277 static void filemon_method_dump_info(FILE *f) {
2278   int i;
2279   fprintf(f,"inotify");
2280   DUMPV("%d",,filemon_inotify_fd);
2281   DUMPV("%d",,filemon_inotify_wdmax);
2282   for (i=0; i<filemon_inotify_wdmax; i++)
2283     fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2284 }
2285
2286 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2287
2288 /*---------- filemon dummy implementation ----------*/
2289
2290 #if !defined(HAVE_FILEMON)
2291
2292 struct Filemon_Perfile { int dummy; };
2293
2294 static int filemon_method_init(void) {
2295   warn("filemon/dummy: no filemon method compiled in");
2296   return 0;
2297 }
2298 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2299 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2300 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2301
2302 #endif /* !HAVE_FILEMON */
2303
2304 /*---------- filemon generic interface ----------*/
2305
2306 static void filemon_start(InputFile *ipf) {
2307   assert(!ipf->filemon);
2308
2309   NEW(ipf->filemon);
2310   filemon_method_startfile(ipf, ipf->filemon);
2311 }
2312
2313 static void filemon_stop(InputFile *ipf) {
2314   if (!ipf->filemon) return;
2315   filemon_method_stopfile(ipf, ipf->filemon);
2316   free(ipf->filemon);
2317   ipf->filemon= 0;
2318 }
2319
2320 /*---------- interface to start and stop an input file ----------*/
2321
2322 static const oop_rd_style feedfile_rdstyle= {
2323   OOP_RD_DELIM_STRIP, '\n',
2324   OOP_RD_NUL_PERMIT,
2325   OOP_RD_SHORTREC_LONG,
2326 };
2327
2328 static void inputfile_reading_resume(InputFile *ipf) {
2329   if (!ipf->rd) return;
2330   if (!ipf->paused) return;
2331
2332   int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2333                      feedfile_got_article,ipf, feedfile_read_err, ipf);
2334   if (r) sysdie("unable start reading feedfile %s",ipf->path);
2335
2336   ipf->paused= 0;
2337 }
2338
2339 static void inputfile_reading_pause(InputFile *ipf) {
2340   if (!ipf->rd) return;
2341   if (ipf->paused) return;
2342   oop_rd_cancel(ipf->rd);
2343   ipf->paused= 1;
2344 }
2345
2346 static void inputfile_reading_start(InputFile *ipf) {
2347   assert(!ipf->rd);
2348   ipf->readable.on_readable= tailing_on_readable;
2349   ipf->readable.on_cancel=   tailing_on_cancel;
2350   ipf->readable.try_read=    tailing_try_read;
2351   ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2352   ipf->readable.delete_kill= 0;
2353
2354   ipf->readable_callback= 0;
2355   ipf->readable_callback_user= 0;
2356
2357   ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2358   assert(ipf->rd);
2359
2360   ipf->paused= 1;
2361   inputfile_reading_resume(ipf);
2362 }
2363
2364 static void inputfile_reading_stop(InputFile *ipf) {
2365   assert(ipf->rd);
2366   inputfile_reading_pause(ipf);
2367   oop_rd_delete(ipf->rd);
2368   ipf->rd= 0;
2369   assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2370 }
2371
2372
2373 /*========== interaction with innd - state machine ==========*/
2374
2375 /* See official state diagram at top of file.  We implement
2376  * this as follows:
2377  * -8<-
2378
2379             .=======.
2380             ||START||
2381             `======='
2382                 |
2383                 | open F
2384                 |
2385                 |    F ENOENT
2386                 |`---------------------------------------------------.
2387       F OPEN OK |                                                    |
2388                 |`---------------- - - -                             |
2389        D ENOENT |       D EXISTS   see OVERALL STATES diagram        |
2390                 |                  for full startup logic            |
2391      ,--------->|                                                    |
2392      |          V                                                    |
2393      |     ============                                       try to |
2394      |      NORMAL                                            open D |
2395      |     [Normal]                                                  |
2396      |      main F tail                                              |
2397      |     ============                                              V
2398      |          |                                                    |
2399      |          | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT            |
2400      ^          | hardlink F to D                                    |
2401      |     [Hardlinked]                                              |
2402      |          | unlink F                                           |
2403      |          | our handle onto F is now onto D                    |
2404      |     [Moved]                                                   |
2405      |          |                                                    |
2406      |          |<-------------------<---------------------<---------+
2407      |          |                                                    |
2408      |          | spawn inndcomm flush                               |
2409      |          V                                                    |
2410      |     ==================                                        |
2411      |      FLUSHING[-ABSENT]                                        |
2412      |     [Flushing]                                                |
2413      |     main D tail/none                                          |
2414      |     ==================                                        |
2415      |          |                                                    |
2416      |          |   INNDCOMM FLUSH FAILS                             ^
2417      |          |`----------------------->----------.                |
2418      |          |                                   |                |
2419      |          |   NO SUCH SITE                    V                |
2420      ^          |`--------------->----.         ==================== |
2421      |          |                      \        FLUSHFAILED[-ABSENT] |
2422      |          |                       \         [Moved]            |
2423      |          | FLUSH OK               \       main D tail/none    |
2424      |          | open F                  \     ==================== |
2425      |          |                          \        |                |
2426      |          |                           \       | TIME TO RETRY  |
2427      |          |`------->----.     ,---<---'\      `----------------'
2428      |          |    D NONE   |     | D NONE  `----.
2429      |          V             |     |              V
2430      |     =============      V     V             ============
2431      |      SEPARATED-1       |     |              DROPPING-1
2432      |      flsh->rd!=0       |     |              flsh->rd!=0
2433      |     [Separated]        |     |             [Dropping]
2434      |      main F idle       |     |              main none
2435      |      flsh D tail       |     |              flsh D tail
2436      |     =============      |     |             ============
2437      |          |             |     | install       |
2438      ^          | EOF ON D    |     |  defer        | EOF ON D
2439      |          V             |     |               V
2440      |     ===============    |     |             ===============
2441      |      SEPARATED-2       |     |              DROPPING-2
2442      |      flsh->rd==0       |     V              flsh->rd==0
2443      |     [Finishing]        |     |             [Dropping]
2444      |      main F tail       |     `.             main none
2445      |      flsh D closed     |       `.           flsh D closed
2446      |     ===============    V         `.        ===============
2447      |          |                         `.          |
2448      |          | ALL D PROCESSED           `.        | ALL D PROCESSED
2449      |          V install defer as backlog    `.      | install defer
2450      ^          | close D                       `.    | close D
2451      |          | unlink D                        `.  | unlink D
2452      |          |                                  |  |
2453      |          |                                  V  V
2454      `----------'                               ==============
2455                                                  DROPPED
2456                                                 [Dropped]
2457                                                  main none
2458                                                  flsh none
2459                                                  some backlog
2460                                                 ==============
2461                                                       |
2462                                                       | ALL BACKLOG DONE
2463                                                       |
2464                                                       | unlink lock
2465                                                       | exit
2466                                                       V
2467                                                   ==========
2468                                                    (ESRCH)
2469                                                   [Droppped]
2470                                                   ==========
2471  * ->8-
2472  */
2473
2474 static void startup_set_input_file(InputFile *f) {
2475   assert(!main_input_file);
2476   main_input_file= f;
2477   inputfile_reading_start(f);
2478 }
2479
2480 static void statemc_lock(void) {
2481   int lockfd;
2482   struct stat stab, stabf;
2483   
2484   for (;;) {
2485     lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2486     if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2487
2488     struct flock fl;
2489     memset(&fl,0,sizeof(fl));
2490     fl.l_type= F_WRLCK;
2491     fl.l_whence= SEEK_SET;
2492     int r= fcntl(lockfd, F_SETLK, &fl);
2493     if (r==-1) {
2494       if (errno==EACCES || isewouldblock(errno)) {
2495         if (quiet_multiple) exit(0);
2496         fatal("another duct holds the lockfile");
2497       }
2498       sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2499     }
2500
2501     xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2502     int lock_noent;
2503     xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2504
2505     if (!lock_noent && samefile(&stab, &stabf))
2506       break;
2507
2508     xclose(lockfd, "stale lockfile ", path_lock);
2509   }
2510
2511   FILE *lockfile= fdopen(lockfd, "w");
2512   if (!lockfile) sysdie("fdopen lockfile");
2513
2514   int r= ftruncate(lockfd, 0);
2515   if (r) sysdie("truncate lockfile to write new info");
2516
2517   if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2518               (unsigned long)self_pid,
2519               sitename, feedfile, remote_host) == EOF ||
2520       fflush(lockfile))
2521     sysfatal("write info to lockfile %s", path_lock);
2522
2523   debug("startup: locked");
2524 }
2525
2526 static void statemc_init(void) {
2527   struct stat stabdefer;
2528
2529   search_backlog_file();
2530
2531   int defer_noent;
2532   xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2533   if (defer_noent) {
2534     debug("startup: ductdefer ENOENT");
2535   } else {
2536     debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2537     switch (stabdefer.st_nlink==1) {
2538     case 1:
2539       open_defer(); /* so that we will later close it and rename it */
2540       break;
2541     case 2:
2542       xunlink(path_defer, "stale defer file link"
2543               " (presumably hardlink to backlog file)");
2544       break;
2545     default:
2546       die("defer file %s has unexpected link count %d",
2547           path_defer, stabdefer.st_nlink);
2548     }
2549   }
2550
2551   struct stat stab_f, stab_d;
2552   int noent_f;
2553
2554   InputFile *file_d= open_input_file(path_flushing);
2555   if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2556
2557   xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2558
2559   if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2560     debug("startup: F==D => Hardlinked");
2561     xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2562     noent_f= 1;
2563   }
2564
2565   if (noent_f) {
2566     debug("startup: F ENOENT => Moved");
2567     if (file_d) startup_set_input_file(file_d);
2568     spawn_inndcomm_flush("feedfile missing at startup");
2569     /* => Flushing, sms:=FLUSHING */
2570   } else {
2571     if (file_d) {
2572       debug("startup: F!=D => Separated");
2573       startup_set_input_file(file_d);
2574       flushing_input_file= main_input_file;
2575       main_input_file= open_input_file(feedfile);
2576       if (!main_input_file) die("feedfile vanished during startup");
2577       SMS(SEPARATED, max_separated_periods,
2578           "found both old and current feed files");
2579     } else {
2580       debug("startup: F exists, D ENOENT => Normal");
2581       InputFile *file_f= open_input_file(feedfile);
2582       if (!file_f) die("feed file vanished during startup");
2583       startup_set_input_file(file_f);
2584       SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2585     }
2586   }
2587 }
2588
2589 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2590   assert(sms == sm_NORMAL);
2591
2592   debug("starting flush (%s) (%lu >?= %lu) (%d)",
2593         why,
2594         (unsigned long)(main_input_file ? main_input_file->offset : 0),
2595         (unsigned long)target_max_feedfile_size,
2596         until_flush);
2597
2598   int r= link(feedfile, path_flushing);
2599   if (r) sysfatal("link feedfile %s to flushing file %s",
2600                   feedfile, path_flushing);
2601   /* => Hardlinked */
2602
2603   xunlink(feedfile, "old feedfile link");
2604   /* => Moved */
2605
2606   spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2607 }
2608
2609 static int trigger_flush_ok(const char *why) {
2610   switch (sms) {
2611
2612   case sm_NORMAL:
2613     statemc_start_flush(why ? why : "periodic");
2614     return 1;                           /* Normal => Flushing; => FLUSHING */
2615
2616   case sm_FLUSHFAILED:
2617     spawn_inndcomm_flush(why ? why : "retry");
2618     return 1;                            /* Moved => Flushing; => FLUSHING */
2619
2620   case sm_SEPARATED:
2621   case sm_DROPPING:
2622     warn("abandoning old feedfile after flush (%s), autodeferring",
2623          why ? why : "took too long to complete");
2624     assert(flushing_input_file);
2625     autodefer_input_file(flushing_input_file);
2626     return 1;
2627
2628   default:
2629     return 0;
2630   }
2631 }
2632
2633 static void statemc_period_poll(void) {
2634   if (!until_flush) return;
2635   until_flush--;
2636   assert(until_flush>=0);
2637
2638   if (until_flush) return;
2639   int ok= trigger_flush_ok(0);
2640   assert(ok);
2641 }
2642
2643 static int inputfile_is_done(InputFile *ipf) {
2644   if (!ipf) return 0;
2645   if (ipf->inprogress) return 0; /* new article in the meantime */
2646   if (ipf->rd) return 0; /* not had EOF */
2647   return 1;
2648 }
2649
2650 static void notice_processed(InputFile *ipf, int completed,
2651                              const char *what, const char *spec) {
2652   if (!ipf) return; /* allows preterminate to be lazy */
2653
2654 #define RCI_NOTHING(x) /* nothing */
2655 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2656 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2657
2658 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2659
2660   char *inprog= completed
2661     ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2662     : xasprintf(" inprogress=%ld", ipf->inprogress);
2663   char *autodefer= ipf->autodefer >= 0
2664     ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2665     : xasprintf("%s","");
2666
2667   info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2668        " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2669        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2670        ,
2671        completed?"completed":"processed", what, spec,
2672        ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2673        inprog, autodefer, ipf->count_nooffer_missing,
2674        CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2675        , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2676        CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2677        , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2678        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
2679        );
2680
2681   free(inprog);
2682   free(autodefer);
2683
2684 #undef CNT
2685 }
2686
2687 static void statemc_check_backlog_done(void) {
2688   InputFile *ipf= backlog_input_file;
2689   if (!inputfile_is_done(ipf)) return;
2690
2691   const char *slash= strrchr(ipf->path, '/');
2692   const char *leaf= slash ? slash+1 : ipf->path;
2693   const char *under= strchr(slash, '_');
2694   const char *rest= under ? under+1 : leaf;
2695   if (!strncmp(rest,"backlog",7)) rest += 7;
2696   notice_processed(ipf,1,"backlog ",rest);
2697
2698   close_input_file(ipf);
2699   if (unlink(ipf->path)) {
2700     if (errno != ENOENT)
2701       sysdie("could not unlink processed backlog file %s", ipf->path);
2702     warn("backlog file %s vanished while we were reading it"
2703          " so we couldn't remove it (but it's done now, anyway)",
2704          ipf->path);
2705   }
2706   free(ipf);
2707   backlog_input_file= 0;
2708   search_backlog_file();
2709   return;
2710 }
2711
2712 static void statemc_check_flushing_done(void) {
2713   InputFile *ipf= flushing_input_file;
2714   if (!inputfile_is_done(ipf)) return;
2715
2716   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2717
2718   notice_processed(ipf,1,"feedfile","");
2719
2720   close_defer();
2721
2722   xunlink(path_flushing, "old flushing file");
2723
2724   close_input_file(flushing_input_file);
2725   free(flushing_input_file);
2726   flushing_input_file= 0;
2727
2728   if (sms==sm_SEPARATED) {
2729     notice("flush complete");
2730     SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2731   } else if (sms==sm_DROPPING) {
2732     SMS(DROPPED, max_separated_periods, "old flush complete");
2733     search_backlog_file();
2734     notice("feed dropped, but will continue until backlog is finished");
2735   }
2736 }
2737
2738 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2739                                       void *u) {
2740   assert(!inputfile_is_done(main_input_file));
2741   statemc_check_flushing_done();
2742   statemc_check_backlog_done();
2743   return OOP_CONTINUE;
2744 }
2745
2746 static void queue_check_input_done(void) {
2747   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2748 }
2749
2750 static void statemc_setstate(StateMachineState newsms, int periods,
2751                              const char *forlog, const char *why) {
2752   sms= newsms;
2753   until_flush= periods;
2754
2755   const char *xtra= "";
2756   switch (sms) {
2757   case sm_FLUSHING:
2758   case sm_FLUSHFAILED:
2759     if (!main_input_file) xtra= "-ABSENT";
2760     break;
2761   case sm_SEPARATED:
2762   case sm_DROPPING:
2763     xtra= flushing_input_file->rd ? "-1" : "-2";
2764     break;
2765   default:;
2766   }
2767
2768   if (periods) {
2769     info("state %s%s[%d] %s",forlog,xtra,periods,why);
2770   } else {
2771     info("state %s%s %s",forlog,xtra,why);
2772   }
2773 }
2774
2775 /*---------- defer and backlog files ----------*/
2776
2777 static void open_defer(void) {
2778   struct stat stab;
2779
2780   if (defer) return;
2781
2782   defer= fopen(path_defer, "a+");
2783   if (!defer) sysfatal("could not open defer file %s", path_defer);
2784
2785   /* truncate away any half-written records */
2786
2787   xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2788
2789   if (stab.st_size > LONG_MAX)
2790     die("defer file %s size is far too large", path_defer);
2791
2792   if (!stab.st_size)
2793     return;
2794
2795   long orgsize= stab.st_size;
2796   long truncto= stab.st_size;
2797   for (;;) {
2798     if (!truncto) break; /* was only (if anything) one half-truncated record */
2799     if (fseek(defer, truncto-1, SEEK_SET) < 0)
2800       sysdie("seek in defer file %s while truncating partial", path_defer);
2801
2802     int r= getc(defer);
2803     if (r==EOF) {
2804       if (ferror(defer))
2805         sysdie("failed read from defer file %s", path_defer);
2806       else
2807         die("defer file %s shrank while we were checking it!", path_defer);
2808     }
2809     if (r=='\n') break;
2810     truncto--;
2811   }
2812
2813   if (stab.st_size != truncto) {
2814     warn("truncating half-record at end of defer file %s -"
2815          " shrinking by %ld bytes from %ld to %ld",
2816          path_defer, orgsize - truncto, orgsize, truncto);
2817
2818     if (fflush(defer))
2819       sysfatal("could not flush defer file %s", path_defer);
2820     if (ftruncate(fileno(defer), truncto))
2821       sysdie("could not truncate defer file %s", path_defer);
2822
2823   } else {
2824     info("continuing existing defer file %s (%ld bytes)",
2825          path_defer, orgsize);
2826   }
2827   if (fseek(defer, truncto, SEEK_SET))
2828     sysdie("could not seek to new end of defer file %s", path_defer);
2829 }
2830
2831 static void close_defer(void) {
2832   if (!defer)
2833     return;
2834
2835   struct stat stab;
2836   xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2837
2838   if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2839   defer= 0;
2840
2841   time_t now= xtime();
2842
2843   char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2844                            (unsigned long)now,
2845                            (unsigned long)stab.st_ino);
2846   if (link(path_defer, backlog))
2847     sysfatal("could not install defer file %s as backlog file %s",
2848            path_defer, backlog);
2849   if (unlink(path_defer))
2850     sysdie("could not unlink old defer link %s to backlog file %s",
2851            path_defer, backlog);
2852
2853   free(backlog);
2854
2855   if (until_backlog_nextscan < 0 ||
2856       until_backlog_nextscan > backlog_retry_minperiods + 1)
2857     until_backlog_nextscan= backlog_retry_minperiods + 1;
2858 }
2859
2860 static void poll_backlog_file(void) {
2861   if (until_backlog_nextscan < 0) return;
2862   if (until_backlog_nextscan-- > 0) return;
2863   search_backlog_file();
2864 }
2865
2866 static void search_backlog_file(void) {
2867   /* returns non-0 iff there are any backlog files */
2868
2869   glob_t gl;
2870   int r, i;
2871   struct stat stab;
2872   const char *oldest_path=0;
2873   time_t oldest_mtime=0, now;
2874
2875   if (backlog_input_file) return;
2876
2877  try_again:
2878
2879   r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2880
2881   switch (r) {
2882   case GLOB_ABORTED:
2883     sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2884   case GLOB_NOSPACE:
2885     fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2886   case 0:
2887     for (i=0; i<gl.gl_pathc; i++) {
2888       const char *path= gl.gl_pathv[i];
2889
2890       if (strchr(path,'#') || strchr(path,'~')) {
2891         debug("backlog file search skipping %s", path);
2892         continue;
2893       }
2894       r= stat(path, &stab);
2895       if (r) {
2896         syswarn("failed to stat backlog file %s", path);
2897         continue;
2898       }
2899       if (!S_ISREG(stab.st_mode)) {
2900         warn("backlog file %s is not a plain file (or link to one)", path);
2901         continue;
2902       }
2903       if (!oldest_path || stab.st_mtime < oldest_mtime) {
2904         oldest_path= path;
2905         oldest_mtime= stab.st_mtime;
2906       }
2907     }
2908   case GLOB_NOMATCH: /* fall through */
2909     break;
2910   default:
2911     sysdie("glob expansion of backlog pattern %s gave unexpected"
2912            " nonzero (error?) return value %d", globpat_backlog, r);
2913   }
2914
2915   if (!oldest_path) {
2916     debug("backlog scan: none");
2917
2918     if (sms==sm_DROPPED) {
2919       preterminate();
2920       notice("feed dropped and our work is complete");
2921
2922       int r= unlink(path_cli);
2923       if (r && errno!=ENOENT)
2924         syswarn("failed to unlink cli socket for old feed");
2925
2926       xunlink(path_lock, "lockfile for old feed");
2927       exit(4);
2928     }
2929     until_backlog_nextscan= backlog_spontrescan_periods;
2930     goto xfree;
2931   }
2932
2933   now= xtime();
2934   double age= difftime(now, oldest_mtime);
2935   long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2936
2937   if (age_deficiency <= 0) {
2938     debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2939           age, age_deficiency, oldest_path);
2940
2941     backlog_input_file= open_input_file(oldest_path);
2942     if (!backlog_input_file) {
2943       warn("backlog file %s vanished as we opened it", oldest_path);
2944       globfree(&gl);
2945       goto try_again;
2946     }
2947     inputfile_reading_start(backlog_input_file);
2948     until_backlog_nextscan= -1;
2949     goto xfree;
2950   }
2951
2952   until_backlog_nextscan= age_deficiency / period_seconds;
2953
2954   if (backlog_spontrescan_periods >= 0 &&
2955       until_backlog_nextscan > backlog_spontrescan_periods)
2956     until_backlog_nextscan= backlog_spontrescan_periods;
2957
2958   debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2959         age, age_deficiency, until_backlog_nextscan, oldest_path);
2960
2961  xfree:
2962   globfree(&gl);
2963   return;
2964 }
2965
2966 /*---------- shutdown and signal handling ----------*/
2967
2968 static void preterminate(void) {
2969   if (in_child) return;
2970   notice_processed(main_input_file,0,"feedfile","");
2971   notice_processed(flushing_input_file,0,"flushing","");
2972   if (backlog_input_file)
2973     notice_processed(backlog_input_file,0, "backlog file ",
2974                      backlog_input_file->path);
2975 }
2976
2977 static int signal_self_pipe[2];
2978 static sig_atomic_t terminate_sig_flag;
2979
2980 static void raise_default(int signo) {
2981   xsigsetdefault(signo);
2982   raise(signo);
2983   abort();
2984 }
2985
2986 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2987   assert(fd=signal_self_pipe[0]);
2988   char buf[PIPE_BUF];
2989   int r= read(signal_self_pipe[0], buf, sizeof(buf));
2990   if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
2991   if (r==0) die("eof on signal self pipe");
2992   if (terminate_sig_flag) {
2993     preterminate();
2994     notice("terminating (%s)", strsignal(terminate_sig_flag));
2995     raise_default(terminate_sig_flag);
2996   }
2997   return OOP_CONTINUE;
2998 }
2999
3000 static void sigarrived_handler(int signum) {
3001   static char x;
3002   switch (signum) {
3003   case SIGTERM:
3004   case SIGINT:
3005     if (!terminate_sig_flag) terminate_sig_flag= signum;
3006     break;
3007   default:
3008     abort();
3009   }
3010   write(signal_self_pipe[1],&x,1);
3011 }
3012
3013 static void init_signals(void) {
3014   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3015     sysdie("could not ignore SIGPIPE");
3016
3017   if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3018
3019   xsetnonblock(signal_self_pipe[0],1);
3020   xsetnonblock(signal_self_pipe[1],1);
3021
3022   struct sigaction sa;
3023   memset(&sa,0,sizeof(sa));
3024   sa.sa_handler= sigarrived_handler;
3025   sa.sa_flags= SA_RESTART;
3026   xsigaction(SIGTERM,&sa);
3027   xsigaction(SIGINT,&sa);
3028
3029   on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3030 }
3031
3032 /*========== flushing the feed ==========*/
3033
3034 static pid_t inndcomm_child;
3035 static int inndcomm_sentinel_fd;
3036
3037 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3038   assert(inndcomm_child);
3039   assert(fd == inndcomm_sentinel_fd);
3040   int status= xwaitpid(&inndcomm_child, "inndcomm");
3041   inndcomm_child= 0;
3042   
3043   cancel_fd_read_except(fd);
3044   xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3045   inndcomm_sentinel_fd= 0;
3046
3047   assert(!flushing_input_file);
3048
3049   if (WIFEXITED(status)) {
3050     switch (WEXITSTATUS(status)) {
3051
3052     case INNDCOMMCHILD_ESTATUS_FAIL:
3053       goto failed;
3054
3055     case INNDCOMMCHILD_ESTATUS_NONESUCH:
3056       notice("feed has been dropped by innd, finishing up");
3057       flushing_input_file= main_input_file;
3058       tailing_make_readable(flushing_input_file);
3059         /* we probably previously returned EAGAIN from our fake read method
3060          * when in fact we were at EOF, so signal another readable event
3061          * so we actually see the EOF */
3062
3063       main_input_file= 0;
3064
3065       if (flushing_input_file) {
3066         SMS(DROPPING, max_separated_periods,
3067             "feed dropped by innd, but must finish last flush");
3068       } else {
3069         close_defer();
3070         SMS(DROPPED, 0, "feed dropped by innd");
3071         search_backlog_file();
3072       }
3073       return OOP_CONTINUE;
3074
3075     case 0:
3076       /* as above */
3077       flushing_input_file= main_input_file;
3078       tailing_make_readable(flushing_input_file);
3079
3080       main_input_file= open_input_file(feedfile);
3081       if (!main_input_file)
3082         die("flush succeeded but feedfile %s does not exist!"
3083             " (this probably means feedfile does not correspond"
3084             " to site %s in newsfeeds)", feedfile, sitename);
3085
3086       if (flushing_input_file) {
3087         SMS(SEPARATED, max_separated_periods, "flush complete");
3088       } else {
3089         close_defer();
3090         SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3091       }
3092       return OOP_CONTINUE;
3093
3094     default:
3095       goto unexpected_exitstatus;
3096
3097     }
3098   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3099     warn("flush timed out trying to talk to innd");
3100     goto failed;
3101   } else {
3102   unexpected_exitstatus:
3103     report_child_status("inndcomm child", status);
3104   }
3105
3106  failed:
3107   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3108   return OOP_CONTINUE;
3109 }
3110
3111 static void inndcommfail(const char *what) {
3112   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3113   exit(INNDCOMMCHILD_ESTATUS_FAIL);
3114 }
3115
3116 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3117   int pipefds[2];
3118
3119   notice("flushing %s",why);
3120
3121   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3122   assert(!inndcomm_child);
3123   assert(!inndcomm_sentinel_fd);
3124
3125   if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3126
3127   inndcomm_child= xfork("inndcomm child");
3128
3129   if (!inndcomm_child) {
3130     const char *flushargv[2]= { sitename, 0 };
3131     char *reply;
3132     int r;
3133
3134     xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3135     /* parent spots the autoclose of pipefds[1] when we die or exit */
3136
3137     if (simulate_flush>=0) {
3138       warn("SIMULATING flush child status %d", simulate_flush);
3139       if (simulate_flush>128) raise(simulate_flush-128);
3140       else exit(simulate_flush);
3141     }
3142
3143     alarm(inndcomm_flush_timeout);
3144     r= ICCopen();                         if (r)   inndcommfail("connect");
3145     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
3146     if (!r) exit(0); /* yay! */
3147
3148     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3149     syswarn("innd ctlinnd flush failed: innd said %s", reply);
3150     exit(INNDCOMMCHILD_ESTATUS_FAIL);
3151   }
3152
3153   simulate_flush= -1;
3154
3155   xclose(pipefds[1], "inndcomm sentinel child's end",0);
3156   inndcomm_sentinel_fd= pipefds[0];
3157   assert(inndcomm_sentinel_fd);
3158   on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3159
3160   SMS(FLUSHING, 0, why);
3161 }
3162
3163 /*========== main program ==========*/
3164
3165 static void postfork_inputfile(InputFile *ipf) {
3166   if (!ipf) return;
3167   xclose(ipf->fd, "(in child) input file ", ipf->path);
3168 }
3169
3170 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3171   /* we have no stdio streams that are buffered long-term */
3172   if (!f) return;
3173   if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3174 }
3175
3176 static void postfork(void) {
3177   in_child= 1;
3178
3179   xsigsetdefault(SIGTERM);
3180   xsigsetdefault(SIGINT);
3181   xsigsetdefault(SIGPIPE);
3182   if (terminate_sig_flag) raise(terminate_sig_flag);
3183
3184   postfork_inputfile(main_input_file);
3185   postfork_inputfile(flushing_input_file);
3186
3187   Conn *conn;
3188   FOR_CONN(conn)
3189     conn_closefd(conn,"(in child) ");
3190
3191   postfork_stdio(defer, "defer file ", path_defer);
3192 }
3193
3194 typedef struct Every Every;
3195 struct Every {
3196   struct timeval interval;
3197   int fixed_rate;
3198   void (*f)(void);
3199 };
3200
3201 static void every_schedule(Every *e, struct timeval base);
3202
3203 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3204   Every *e= e_v;
3205   e->f();
3206   if (!e->fixed_rate) xgettimeofday(&base);
3207   every_schedule(e, base);
3208   return OOP_CONTINUE;
3209 }
3210
3211 static void every_schedule(Every *e, struct timeval base) {
3212   struct timeval when;
3213   timeradd(&base, &e->interval, &when);
3214   loop->on_time(loop, when, every_happens, e);
3215 }
3216
3217 static void every(int interval, int fixed_rate, void (*f)(void)) {
3218   NEW_DECL(Every *,e);
3219   e->interval.tv_sec= interval;
3220   e->interval.tv_usec= 0;
3221   e->fixed_rate= fixed_rate;
3222   e->f= f;
3223   struct timeval now;
3224   xgettimeofday(&now);
3225   every_schedule(e, now);
3226 }
3227
3228 static void filepoll(void) {
3229   tailing_make_readable(main_input_file);
3230   tailing_make_readable(flushing_input_file);
3231 }
3232
3233 static char *debug_report_ipf(InputFile *ipf) {
3234   if (!ipf) return xasprintf("none");
3235
3236   const char *slash= strrchr(ipf->path,'/');
3237   const char *path= slash ? slash+1 : ipf->path;
3238
3239   return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3240                    ipf, path,
3241                    ipf->queue.count, ipf->inprogress, ipf->autodefer,
3242                    (long)ipf->offset, ipf->fd,
3243                    ipf->rd ? "" : ",!rd",
3244                    ipf->skippinglong ? "*skiplong" : "",
3245                    ipf->rd && ipf->paused ? "*paused" : "");
3246 }
3247
3248 static void period(void) {
3249   char *dipf_main=     debug_report_ipf(main_input_file);
3250   char *dipf_flushing= debug_report_ipf(flushing_input_file);
3251   char *dipf_backlog=  debug_report_ipf(backlog_input_file);
3252
3253   debug("PERIOD"
3254         " sms=%s[%d] conns=%d until_connect=%d"
3255         " input_files main:%s flushing:%s backlog:%s[%d]"
3256         " children connecting=%ld inndcomm=%ld"
3257         ,
3258         sms_names[sms], until_flush, conns.count, until_connect,
3259         dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3260         (long)connecting_child, (long)inndcomm_child
3261         );
3262
3263   free(dipf_main);
3264   free(dipf_flushing);
3265   free(dipf_backlog);
3266
3267   if (until_connect) until_connect--;
3268
3269   inputfile_queue_check_expired(backlog_input_file);
3270   poll_backlog_file();
3271   if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3272   statemc_period_poll();
3273   check_assign_articles();
3274   check_idle_conns();
3275 }
3276
3277
3278 /*========== dumping state ==========*/
3279
3280 static void dump_article_list(FILE *f, const CliCommand *c,
3281                               const ArticleList *al) {
3282   fprintf(f, " count=%d\n", al->count);
3283   if (!c->xval) return;
3284   
3285   int i; Article *art;
3286   for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3287     fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3288     DUMPV("%p", art->,ipf);
3289     DUMPV("%d", art->,missing);
3290     DUMPV("%lu", (unsigned long)art->,offset);
3291     DUMPV("%d", art->,blanklen);
3292     DUMPV("%d", art->,midlen);
3293     fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3294   }
3295 }
3296   
3297 static void dump_input_file(FILE *f, const CliCommand *c,
3298                             InputFile *ipf, const char *wh) {
3299   char *dipf= debug_report_ipf(ipf);
3300   fprintf(f,"input %s %s", wh, dipf);
3301   free(dipf);
3302   
3303   if (ipf) {
3304     DUMPV("%d", ipf->,readcount_ok);
3305     DUMPV("%d", ipf->,readcount_blank);
3306     DUMPV("%d", ipf->,readcount_err);
3307     DUMPV("%d", ipf->,count_nooffer_missing);
3308   }
3309   fprintf(f,"\n");
3310   if (ipf) {
3311     ArtState state; const char *const *statename; 
3312     for (state=0, statename=artstate_names; *statename; state++,statename++) {
3313 #define RC_DUMP_FMT(x) " " #x "=%d"
3314 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3315       fprintf(f,"input %s counts %-11s"
3316               RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3317               wh, *statename
3318               RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3319     }
3320     fprintf(f,"input %s queue", wh);
3321     dump_article_list(f,c,&ipf->queue);
3322   }
3323 }
3324
3325 CCMD(dump) {
3326   int i;
3327   fprintf(cc->out, "dumping state to %s\n", path_dump);
3328   FILE *f= fopen(path_dump, "w");
3329   if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3330
3331   fprintf(f,"general");
3332   DUMPV("%s", sms_names,[sms]);
3333   DUMPV("%d", ,until_flush);
3334   DUMPV("%ld", (long),self_pid);
3335   DUMPV("%p", , defer);
3336   DUMPV("%d", , until_connect);
3337   DUMPV("%d", , until_backlog_nextscan);
3338   DUMPV("%d", , simulate_flush);
3339   fprintf(f,"\nnocheck");
3340   DUMPV("%#.10f", , accept_proportion);
3341   DUMPV("%d", , nocheck);
3342   DUMPV("%d", , nocheck_reported);
3343   fprintf(f,"\n");
3344
3345   fprintf(f,"special");
3346   DUMPV("%ld", (long),connecting_child);
3347   DUMPV("%d", , connecting_fdpass_sock);
3348   DUMPV("%d", , cli_master);
3349   fprintf(f,"\n");
3350
3351   fprintf(f,"filemon ");
3352   filemon_method_dump_info(f);
3353
3354   dump_input_file(f,c, main_input_file,     "main"    );
3355   dump_input_file(f,c, flushing_input_file, "flushing");
3356   dump_input_file(f,c, backlog_input_file,  "backlog" );
3357
3358   fprintf(f,"conns count=%d\n", conns.count);
3359
3360   Conn *conn;
3361   FOR_CONN(conn) {
3362
3363     fprintf(f,"C%d",conn->fd);
3364     DUMPV("%p",conn->,rd);             DUMPV("%d",conn->,max_queue);
3365     DUMPV("%d",conn->,stream);         DUMPV("%d",conn->,quitting);
3366     DUMPV("%d",conn->,since_activity);
3367     fprintf(f,"\n");
3368
3369     fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3370     fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3371     fprintf(f,"C%d sent",    conn->fd); dump_article_list(f,c,&conn->sent);
3372
3373     fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3374     for (i=0; i<conn->xmitu; i++) {
3375       const struct iovec *iv= &conn->xmit[i];
3376       const XmitDetails *xd= &conn->xmitd[i];
3377       char *dinfo;
3378       switch (xd->kind) {
3379       case xk_Const:    dinfo= xasprintf("Const");                 break;
3380       case xk_Artdata:  dinfo= xasprintf("A%p", xd->info.sm_art);  break;
3381       default:
3382         abort();
3383       }
3384       fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3385               sanitise(iv->iov_base, iv->iov_len));
3386       free(dinfo);
3387     }
3388   }
3389
3390   fprintf(f,"paths");
3391   DUMPV("%s", , feedfile);
3392   DUMPV("%s", , path_cli);
3393   DUMPV("%s", , path_lock);
3394   DUMPV("%s", , path_flushing);
3395   DUMPV("%s", , path_defer);
3396   DUMPV("%s", , path_dump);
3397   DUMPV("%s", , globpat_backlog);
3398   fprintf(f,"\n");
3399
3400   if (!!ferror(f) + !!fclose(f)) {
3401     fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3402     return;
3403   }
3404 }
3405
3406 /*========== option parsing ==========*/
3407
3408 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3409 static void vbadusage(const char *fmt, va_list al) {
3410   char *m= xvasprintf(fmt,al);
3411   fprintf(stderr, "bad usage: %s\n"
3412           "say --help for help, or read the manpage\n",
3413           m);
3414   if (become_daemon)
3415     syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3416   exit(8);
3417 }
3418
3419 /*---------- generic option parser ----------*/
3420
3421 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3422 static void badusage(const char *fmt, ...) {
3423   va_list al;
3424   va_start(al,fmt);
3425   vbadusage(fmt,al);
3426 }
3427
3428 enum OptFlags {
3429   of_seconds= 001000u,
3430   of_boolean= 002000u,
3431 };
3432
3433 typedef struct Option Option;
3434 typedef void OptionParser(const Option*, const char *val);
3435
3436 struct Option {
3437   int shrt;
3438   const char *lng, *formarg;
3439   void *store;
3440   OptionParser *fn;
3441   int intval;
3442 };
3443
3444 static void parse_options(const Option *options, char ***argvp) {
3445   /* on return *argvp is first non-option arg; argc is not updated */
3446
3447   for (;;) {
3448     const char *arg= *++(*argvp);
3449     if (!arg) break;
3450     if (*arg != '-') break;
3451     if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3452     int a;
3453     while ((a= *++arg)) {
3454       const Option *o;
3455       if (a=='-') {
3456         arg++;
3457         char *equals= strchr(arg,'=');
3458         int len= equals ? (equals - arg) : strlen(arg);
3459         for (o=options; o->shrt || o->lng; o++)
3460           if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3461             goto found_long;
3462         badusage("unknown long option --%s",arg);
3463       found_long:
3464         if (!o->formarg) {
3465           if (equals) badusage("option --%s does not take a value",o->lng);
3466           arg= 0;
3467         } else if (equals) {
3468           arg= equals+1;
3469         } else {
3470           arg= *++(*argvp);
3471           if (!arg) badusage("option --%s needs a value for %s",
3472                              o->lng, o->formarg);
3473         }
3474         o->fn(o, arg);
3475         break; /* eaten the whole argument now */
3476       }
3477       for (o=options; o->shrt || o->lng; o++)
3478         if (a == o->shrt)
3479           goto found_short;
3480       badusage("unknown short option -%c",a);
3481     found_short:
3482       if (!o->formarg) {
3483         o->fn(o,0);
3484       } else {
3485         if (!*++arg) {
3486           arg= *++(*argvp);
3487           if (!arg) badusage("option -%c needs a value for %s",
3488                              o->shrt, o->formarg);
3489         }
3490         o->fn(o,arg);
3491         break; /* eaten the whole argument now */
3492       }
3493     }
3494   }
3495 }
3496
3497 #define DELIMPERHAPS(delim,str)  (str) ? (delim) : "", (str) ? (str) : ""
3498
3499 static void print_options(const Option *options, FILE *f) {
3500   const Option *o;
3501   for (o=options; o->shrt || o->lng; o++) {
3502     char shrt[2] = { o->shrt, 0 };
3503     char *optspec= xasprintf("%s%s%s%s%s",
3504                              o->shrt ? "-" : "", shrt,
3505                              o->shrt && o->lng ? "|" : "",
3506                              DELIMPERHAPS("--", o->lng));
3507     fprintf(f, "  %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3508     free(optspec);
3509   }
3510 }
3511
3512 /*---------- specific option types ----------*/
3513
3514 static void op_integer(const Option *o, const char *val) {
3515   char *ep;
3516   errno= 0;
3517   unsigned long ul= strtoul(val,&ep,10);
3518   if (*ep || ep==val || errno || ul>INT_MAX)
3519     badusage("bad integer value for %s",o->lng);
3520   int *store= o->store;
3521   *store= ul;
3522 }
3523
3524 static void op_double(const Option *o, const char *val) {
3525   int *store= o->store;
3526   char *ep;
3527   errno= 0;
3528   *store= strtod(val, &ep);
3529   if (*ep || ep==val || errno)
3530     badusage("bad floating point value for %s",o->lng);
3531 }
3532
3533 static void op_string(const Option *o, const char *val) {
3534   const char **store= o->store;
3535   *store= val;
3536 }
3537
3538 static void op_seconds(const Option *o, const char *val) {
3539   int *store= o->store;
3540   char *ep;
3541   int unit;
3542
3543   double v= strtod(val,&ep);
3544   if (ep==val) badusage("bad time/duration value for %s",o->lng);
3545
3546   if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3547   else if (!strcmp(ep,"m") || !strcmp(ep,"min"))    unit= 60;
3548   else if (!strcmp(ep,"h") || !strcmp(ep,"hour"))   unit= 3600;
3549   else if (!strcmp(ep,"d") || !strcmp(ep,"day"))    unit= 86400;
3550   else if (!strcmp(ep,"das")) unit= 10;
3551   else if (!strcmp(ep,"hs"))  unit= 100;
3552   else if (!strcmp(ep,"ks"))  unit= 1000;
3553   else if (!strcmp(ep,"Ms"))  unit= 1000000;
3554   else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3555
3556   v *= unit;
3557   v= ceil(v);
3558   if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3559   *store= v;
3560 }
3561
3562 static void op_setint(const Option *o, const char *val) {
3563   int *store= o->store;
3564   *store= o->intval;
3565 }
3566
3567 /*---------- specific options ----------*/
3568
3569 static void help(const Option *o, const char *val);
3570
3571 static const Option innduct_options[]= {
3572 {'f',"feedfile",         "F",     &feedfile,                 op_string      },
3573 {'q',"quiet-multiple",   0,       &quiet_multiple,           op_setint, 1   },
3574 {0,"no-daemon",          0,       &become_daemon,            op_setint, 0   },
3575 {0,"no-streaming",       0,       &try_stream,               op_setint, 0   },
3576 {0,"no-filemon",         0,       &try_filemon,              op_setint, 0   },
3577 {'C',"inndconf",         "F",     &inndconffile,             op_string      },
3578 {'P',"port",             "PORT",  &port,                     op_integer     },
3579 {0,"chdir",              "DIR",   &path_run,                 op_string      },
3580 {0,"cli",            "DIR/|PATH", &path_cli,                 op_string      },
3581 {0,"help",               0,       0,                         help           },
3582
3583 {0,"max-connections",    "N",     &max_connections,          op_integer     },
3584 {0,"max-queue-per-conn", "N",     &max_queue_per_conn,       op_integer     },
3585 {0,"max-queue-per-file", "N",     &max_queue_per_ipf,        op_integer     },
3586 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer     },
3587 {0,"period-interval",    "TIME",  &period_seconds,           op_seconds     },
3588
3589 {0,"connection-timeout",   "TIME",  &connection_setup_timeout, op_seconds   },
3590 {0,"stuck-flush-timeout",  "TIME",  &inndcomm_flush_timeout,   op_seconds   },
3591 {0,"feedfile-poll",        "TIME",  &filepoll_seconds,         op_seconds   },
3592
3593 {0,"no-check-proportion",   "PERCENT",   &nocheck_thresh,       op_double   },
3594 {0,"no-check-response-time","ARTICLES",  &nocheck_decay,        op_double   },
3595
3596 {0,"reconnect-interval",     "PERIOD", &reconnect_delay_periods,  op_seconds },
3597 {0,"flush-retry-interval",   "PERIOD", &flushfail_retry_periods,  op_seconds },
3598 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3599 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3600 {0,"max-flush-interval",     "PERIOD", &spontaneous_flush_periods,op_seconds },
3601 {0,"flush-finish-timeout",   "PERIOD", &max_separated_periods,    op_seconds },
3602 {0,"idle-timeout",           "PERIOD", &need_activity_periods,    op_seconds },
3603
3604 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio,   op_double    },
3605 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer   },
3606
3607 {0,0}
3608 };
3609
3610 static void printusage(FILE *f) {
3611   fputs("usage: innduct [options] site [fqdn]\n"
3612         "available options are:\n", f);
3613   print_options(innduct_options, f);
3614 }
3615
3616 static void help(const Option *o, const char *val) {
3617   printusage(stdout);
3618   if (ferror(stdout) || fflush(stdout)) {
3619     perror("innduct: writing help");
3620     exit(12);
3621   }
3622   exit(0);
3623 }
3624
3625 static void convert_to_periods_rndup(int *store) {
3626   *store += period_seconds-1;
3627   *store /= period_seconds;
3628 }
3629
3630 static int path_ends_slash(const char *specified) {
3631   int l= strlen(specified);
3632   assert(l);
3633   return specified[l-1] == '/';
3634 }
3635
3636 int main(int argc, char **argv) {
3637   if (!argv[1]) {
3638     printusage(stderr);
3639     exit(8);
3640   }
3641
3642   parse_options(innduct_options, &argv);
3643
3644   /* arguments */
3645
3646   sitename= *argv++;
3647   if (!sitename) badusage("need site name argument");
3648
3649   if (*argv) remote_host= *argv++;
3650   else remote_host= sitename;
3651   
3652   if (*argv) badusage("too many non-option arguments");
3653
3654   /* defaults */
3655
3656   int r= innconf_read(inndconffile);
3657   if (!r) badusage("could not read inn.conf (more info on stderr)");
3658
3659   if (!remote_host) remote_host= sitename;
3660
3661   if (nocheck_thresh < 0 || nocheck_thresh > 100)
3662     badusage("nocheck threshold percentage must be between 0..100");
3663   nocheck_thresh *= 0.01;
3664
3665   if (nocheck_decay < 0.1)
3666     badusage("nocheck decay articles must be at least 0.1");
3667   nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3668
3669   convert_to_periods_rndup(&reconnect_delay_periods);
3670   convert_to_periods_rndup(&flushfail_retry_periods);
3671   convert_to_periods_rndup(&backlog_retry_minperiods);
3672   convert_to_periods_rndup(&backlog_spontrescan_periods);
3673   convert_to_periods_rndup(&spontaneous_flush_periods);
3674   convert_to_periods_rndup(&max_separated_periods);
3675   convert_to_periods_rndup(&need_activity_periods);
3676
3677   if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3678     badusage("bad input data ratio must be between 0..100");
3679   max_bad_data_ratio *= 0.01;
3680
3681   if (!path_run)
3682     path_run= innconf->pathrun;
3683
3684   if (!feedfile) feedfile= sitename;
3685   if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3686   if (path_ends_slash(feedfile))
3687     feedfile= xasprintf("%s%s", feedfile, sitename);
3688   if (feedfile[0] != '/')
3689     feedfile= xasprintf("%s/%s", innconf->pathoutgoing, feedfile);
3690
3691   if (!path_cli) {
3692     path_cli_dir= "innduct";
3693   } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3694     path_cli= 0; /* ok, don't then */
3695   } else if (path_ends_slash(path_cli)) {
3696     path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3697   }
3698   if (path_cli_dir)
3699     path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3700
3701   if (max_queue_per_ipf<0)
3702     max_queue_per_ipf= max_queue_per_conn * 2;
3703
3704   const char *feedfile_forbidden= "?*[~#";
3705   int c;
3706   while ((c= *feedfile_forbidden++))
3707     if (strchr(feedfile, c))
3708       badusage("feed filename may not contain metacharacter %c",c);
3709
3710   /* set things up */
3711
3712   path_lock=        xasprintf("%s_lock",      feedfile);
3713   path_flushing=    xasprintf("%s_flushing",  feedfile);
3714   path_defer=       xasprintf("%s_defer",     feedfile);
3715   path_dump=        xasprintf("%s_dump",      feedfile);
3716   globpat_backlog=  xasprintf("%s_backlog*",  feedfile);
3717
3718   oop_source_sys *sysloop= oop_sys_new();
3719   if (!sysloop) sysdie("could not create liboop event loop");
3720   loop= (oop_source*)sysloop;
3721
3722   LIST_INIT(conns);
3723
3724   if (become_daemon) {
3725     int i;
3726     for (i=3; i<255; i++)
3727       /* do this now before we open syslog, etc. */
3728       close(i);
3729     openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3730
3731     int null= open("/dev/null",O_RDWR);
3732     if (null<0) sysfatal("failed to open /dev/null");
3733     dup2(null,0);
3734     dup2(null,1);
3735     dup2(null,2);
3736     xclose(null, "/dev/null original fd",0);
3737
3738     pid_t child1= xfork("daemonise first fork");
3739     if (child1) _exit(0);
3740
3741     pid_t sid= setsid();
3742     if (sid == -1) sysfatal("setsid failed");
3743
3744     pid_t child2= xfork("daemonise second fork");
3745     if (child2) _exit(0);
3746   }
3747
3748   self_pid= getpid();
3749   if (self_pid==-1) sysdie("getpid");
3750
3751   r= chdir(path_run);
3752   if (r) sysdie("could not chdir to pathrun %s", path_run);
3753
3754   statemc_lock();
3755
3756   init_signals();
3757
3758   notice("starting");
3759
3760   int val= 1;
3761   r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3762   r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3763
3764   if (!become_daemon)
3765     cli_stdio();
3766
3767   cli_init();
3768
3769   int filemon_ok= 0;
3770   if (!try_filemon) {
3771     notice("filemon: suppressed by command line option, polling");
3772   } else {
3773     filemon_ok= filemon_method_init();
3774     if (!filemon_ok)
3775       warn("filemon: no file monitoring available, polling");
3776   }
3777   if (!filemon_ok)
3778     every(filepoll_seconds,0,filepoll);
3779
3780   every(period_seconds,1,period);
3781
3782   statemc_init();
3783
3784   /* let's go */
3785
3786   void *run= oop_sys_run(sysloop);
3787   assert(run == OOP_ERROR);
3788   sysdie("event loop failed");
3789 }