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