backends/innduct.c

   1 /*
   2  * TODO
   3  *  - close idle connections
   4  *  - -k kill mode ?
   5  */
   6
   7 /*
   8  * Newsfeeds file entries should look like this:
   9  *     host.name.of.site[/exclude,exclude,...]\
  10  *             :pattern,pattern...[/distribution,distribution...]\
  11  *             :Tf,Wnm
  12  *             :
  13  * or
  14  *     sitename[/exclude,exclude,...]\
  15  *             :pattern,pattern...[/distribution,distribution...]\
  16  *             :Tf,Wnm
  17  *             :host.name.of.site
  18  *
  19  * Four files full of
  20  *    token messageid
  21  * or might be blanked out
  22  *    <spc><spc><spc><spc>....
  23  *
  24  * F site.name                 main feed file
  25  *                                opened/created, then written, by innd
  26  *                                read by duct
  27  *                                unlinked by duct
  28  *                                tokens blanked out by duct when processed
  29  *   site.name_lock            lock preventing multiple ducts
  30  *                                to hold lock must open,F_SETLK[W]
  31  *                                  and then stat to check that locked file
  32  *                                  still has name site.name_lock
  33  *                                holder of this lock is "duct"
  34  *                                (only) lockholder may remove the lockfile
  35  * D site.name_flushing        temporary feed file during flush (or crash)
  36  *                                hardlink created by duct
  37  *                                unlinked by duct
  38  *   site.name_defer           431'd articles, still being written,
  39  *                                created, written, used by duct
  40  *
  41  *   site.name_backlog.<date>.<inum>
  42  *                             431'd articles, ready for innxmit or duct
  43  *                                created (link/mv) by duct
  44  *   site.name_backlog<anything-else>  (where <anything-else> does not
  45  *                                      contain '#' or '~') eg
  46  *   site.name_backlog.manual
  47  *                             anything the sysadmin likes (eg, feed files
  48  *                             from old feeds to be merged into this one)
  49  *                                created (link/mv) by admin
  50  *                                may be symlinks (in which case links
  51  *                                may be written through, but only links
  52  *                                will be removed.
  53  *
  54  *                             It is safe to remove backlog files manually,
  55  *                             if it's desired to throw away the backlog.
  56  *
  57  * Backlog files are also processed by innduct.  We find the oldest
  58  * backlog file which is at least a certain amount old, and feed it
  59  * back into our processing.  When every article in it has been read
  60  * and processed, we unlink it and look for another backlog file.
  61  *
  62  * If we don't have a backlog file that we're reading, we close the
  63  * defer file that we're writing and make it into a backlog file at
  64  * the first convenient opportunity.
  65  * -8<-
  66
  67
  68    OVERALL STATES:
  69
  70                                                                 START
  71                                                                   |
  72      ,-->--.                                                 check F, D
  73      |     |                                                      |
  74      |     |                                                      |
  75      |     |  <----------------<---------------------------------'|
  76      |     |                                       F exists       |
  77      |     |                                       D ENOENT       |
  78      |     |  duct opens F                                        |
  79      |     V                                                      |
  80      |  Normal                                                    |
  81      |   F: innd writing, duct reading                            |
  82      |   D: ENOENT                                                |
  83      |     |                                                      |
  84      |     |  duct decides time to flush                          |
  85      |     |  duct makes hardlink                                 |
  86      |     |                                                      |
  87      |     V                            <------------------------'|
  88      |  Hardlinked                                  F==D          |
  89      |   F == D: innd writing, duct reading         both exist    |
  90      ^     |                                                      |
  91      |     |  duct unlinks F                                      |
  92      |     |                        <-----------<-------------<--'|
  93      |     |                           open D         F ENOENT    |
  94      |     |                           if exists                  |
  95      |     |                                                      |
  96      |     V                        <---------------------.       |
  97      |  Moved                                             |       |
  98      |   F: ENOENT                                        |       |
  99      |   D: innd writing, duct reading; or ENOENT         |       |
 100      |     |                                              |       |
 101      |     |  duct requests flush of feed                 |       |
 102      |     |   (others can too, harmlessly)               |       |
 103      |     V                                              |       |
 104      |  Flushing                                          |       |
 105      |   F: ENOENT                                        |       |
 106      |   D: innd flushing, duct; or ENOENT                |       |
 107      |     |                                              |       |
 108      |     |   inndcomm flush fails                       |       |
 109      |     |`-------------------------->------------------'       |
 110      |     |                                                      |
 111      |     |   inndcomm reports no such site                      |
 112      |     |`---------------------------------------------------- | -.
 113      |     |                                                      |  |
 114      |     |  innd finishes writing D, creates F                  |  |
 115      |     |  inndcomm reports flush successful                   |  |
 116      |     |                                                      |  |
 117      |     V                                                      |  |
 118      |  Separated                                <----------------'  |
 119      |   F: innd writing                            F!=D             /
 120      |   D: duct reading; or ENOENT                  both exist     /
 121      |     |                                                       /
 122      |     |  duct gets to the end of D                           /
 123      |     |  duct opens F too                                   /
 124      |     V                                                    /
 125      |  Finishing                                              /
 126      |   F: innd writing, duct reading                        |
 127      |   D: duct finishing                                    V
 128      |     |                                            Dropping
 129      |     |  duct finishes processing D                 F: ENOENT
 130      |     V  duct unlinks D                             D: duct reading
 131      |     |                                                  |
 132      `--<--'                                                  | duct finishes
 133                                                               |  processing D
 134                                                               | duct unlinks D
 135                                                               | duct exits
 136                                                               V
 137                                                         Dropped
 138                                                          F: ENOENT
 139                                                          D: ENOENT
 140                                                          duct not running
 141
 142    "duct reading" means innduct is reading the file but also
 143    overwriting processed tokens.
 144
 145  * ->8- -^L-
 146  *
 147  * rune for printing diagrams:
 148
 149 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
 150
 151  *
 152  */
 153
 154 /*============================== PROGRAM ==============================*/
 155
 156 #define _GNU_SOURCE
 157
 158 #include "inn/list.h"
 159 #include "config.h"
 160 #include "storage.h"
 161 #include "nntp.h"
 162 #include "libinn.h"
 163
 164 #include <sys/uio.h>
 165 #include <sys/types.h>
 166 #include <sys/wait.h>
 167 #include <sys/stat.h>
 168 #include <sys/socket.h>
 169 #include <unistd.h>
 170 #include <string.h>
 171 #include <signal.h>
 172 #include <stdio.h>
 173 #include <errno.h>
 174 #include <syslog.h>
 175 #include <fcntl.h>
 176 #include <stdarg.h>
 177 #include <assert.h>
 178 #include <stdlib.h>
 179
 180 #include <oop.h>
 181 #include <oop-read.h>
 182
 183 /*----- general definitions, probably best not changed -----*/
 184
 185 #define PERIOD_SECONDS 60
 186
 187 #define CONNCHILD_ESTATUS_STREAM   4
 188 #define CONNCHILD_ESTATUS_NOSTREAM 5
 189
 190 #define INNDCOMMCHILD_ESTATUS_FAIL     6
 191 #define INNDCOMMCHILD_ESTATUS_NONESUCH 7
 192
 193 /*----- doubly linked lists -----*/
 194
 195 #define ISNODE(T)   struct { T *succ, *pred; } node  /* must be at start */
 196 #define DEFLIST(T)  typedef struct { T *hd, *tl, *tp; int count; } T##List
 197
 198 #define NODE(n) (assert((void*)&(n)->node == &(n)), \
 199                  (struct node*)&(n)->node)
 200
 201 #define LIST_CHECKCANHAVENODE(l,n) \
 202   ((void)((n) == ((l).hd))) /* just for the type check */
 203
 204 #define LIST_ADDSOMEHOW(l,n,list_addsomehow)            \
 205  ( LIST_CHECKCANHAVENODE(l,n),                          \
 206    list_addsomehow((struct list*)&(l), NODE((n))),      \
 207    (void)(l).count++                                    \
 208    )
 209
 210 #define LIST_REMSOMEHOW(l,list_remsomehow)      \
 211  ( (typeof((l).hd))                             \
 212    ( (l).count                                  \
 213      ? ( (l).count--,                           \
 214          list_remsomehow((struct list*)&(l)) )  \
 215      : 0                                        \
 216      )                                          \
 217    )
 218
 219
 220 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
 221 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
 222 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
 223 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
 224
 225 #define LIST_HEAD(l) ((typeof((l).hd))(list_head((struct list*)&(l))))
 226 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
 227 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
 228
 229 #define LIST_REMOVE(l,n)                        \
 230  ( LIST_CHECKCANHAVENODE(l,n),                  \
 231    list_remove(NODE((n))),                      \
 232    (void)(l).count--                            \
 233    )
 234
 235 #define LIST_INSERT(l,n,pred)                                   \
 236  ( LIST_CHECKCANHAVENODE(l,n),                                  \
 237    LIST_CHECKCANHAVENODE(l,pred),                               \
 238    list_insert((struct list*)&(l), NODE((n)), NODE((pred))),    \
 239    (void)(l).count++                                            \
 240    )
 241
 242 /*----- type predeclarations -----*/
 243
 244 typedef struct Conn Conn;
 245 typedef struct Article Article;
 246 typedef struct InputFile InputFile;
 247 typedef struct XmitDetails XmitDetails;
 248 typedef enum StateMachineState StateMachineState;
 249
 250 DEFLIST(Conn);
 251 DEFLIST(Article);
 252
 253 /*----- function predeclarations -----*/
 254
 255 static void conn_maybe_write(Conn *conn);
 256 static void conn_make_some_xmits(Conn *conn);
 257 static void *conn_write_some_xmits(Conn *conn);
 258
 259 static void xmit_free(XmitDetails *d);
 260
 261 static int filemon_init(void);
 262 static void filemon_setfile(int mainfeed_fd, const char *mainfeed_path);
 263 static void filemon_callback(void);
 264
 265 static void statemc_setstate(StateMachineState newsms, int periods,
 266                              const char *forlog, const char *why);
 267 static void check_master_queue(void);
 268 static void queue_check_input_done(void);
 269
 270 static void postfork(const char *what);
 271 static void postfork_inputfile(InputFile *ipf);
 272
 273 /*----- configuration options -----*/
 274
 275 static char *sitename, *feedfile;
 276 static const char *remote_host;
 277 static int quiet_multiple=0, become_daemon=1;
 278
 279 static int max_connections=10, max_queue_per_conn=200;
 280
 281 static int connection_setup_timeout=200, port=119, try_stream=1;
 282 static int inndcomm_flush_timeout=100;
 283 static int reconnect_delay_periods, flushfail_retry_periods, open_wait_periods;
 284 static int backlog_retry_minperiods, backlog_spontaneous_rescan_periods;
 285 static const char *inndconffile;
 286
 287 static double accept_proportion;
 288 static double nocheck_thresh_pct= 95.0;
 289 static double nocheck_thresh; /* computed in main from _pct */
 290 static double nocheck_decay_articles= 100; /* converted to _decay */
 291 static double nocheck_decay; /* computed in main from _articles */
 292 static int nocheck, nocheck_reported;
 293
 294
 295 /*----- statistics -----*/
 296
 297 typedef enum {      /* in queue                 in conn->sent             */
 298   art_Unchecked,    /*   not checked, not sent    checking                */
 299   art_Wanted,       /*   checked, wanted          sent body as requested  */
 300   art_Unsolicited,  /*   -                        sent body without check */
 301   art_MaxState
 302 } ArtState;
 303
 304 #define RESULT_COUNTS(RCS,RCN)                  \
 305   RCS(sent)                                     \
 306   RCS(accepted)                                 \
 307   RCN(unwanted)                                 \
 308   RCN(rejected)                                 \
 309   RCN(deferred)                                 \
 310   RCN(connretry)
 311
 312 #define RCI_TRIPLE_FMT_BASE "%d(id%d+bd%d+nc%d)"
 313 #define RCI_TRIPLE_VALS_BASE(counts,x)          \
 314        counts[art_Unchecked] x                  \
 315        + counts[art_Wanted] x                   \
 316        + counts[art_Unsolicited] x,             \
 317        counts[art_Unchecked] x                  \
 318        , counts[art_Wanted] x                   \
 319        , counts[art_Unsolicited] x
 320
 321 typedef enum {
 322 #define RC_INDEX(x) RC_##x,
 323   RESULT_COUNTS(RC_INDEX, RC_INDEX)
 324   RCI_max
 325 } ResultCountIndex;
 326
 327
 328 /*----- transmission buffers -----*/
 329
 330 #define CONNIOVS 128
 331
 332 typedef enum {
 333   xk_Malloc, xk_Const, xk_Artdata
 334 } XmitKind;
 335
 336 struct XmitDetails {
 337   XmitKind kind;
 338   union {
 339     char *malloc_tofree;
 340     ARTHANDLE *sm_art;
 341   } info;
 342 };
 343
 344
 345 /*----- core operational data structure types -----*/
 346
 347 struct InputFile {
 348   /* This is also an instance of struct oop_readable */
 349   struct oop_readable readable; /* first */
 350   oop_readable_call *readable_callback;
 351   void *readable_callback_user;
 352
 353   int fd;
 354   struct Filemon_Perfile *filemon;
 355
 356   oop_read *rd;
 357   long inprogress; /* no. of articles read but not processed */
 358   off_t offset;
 359
 360   int counts[art_MaxState][RCI_max];
 361   char path[];
 362 };
 363
 364 struct Article {
 365   ISNODE(Article);
 366   ArtState state;
 367   int midlen;
 368   InputFile *ipf;
 369   TOKEN token;
 370   off_t offset;
 371   int blanklen;
 372   char messageid[1];
 373 };
 374
 375 #define SMS_LIST(X)                             \
 376   X(NORMAL)                                     \
 377   X(FLUSHING)                                   \
 378   X(FLUSHFAILED)                                \
 379   X(SEPARATED)                                  \
 380   X(DROPPING)                                   \
 381   X(DROPPED)
 382
 383 enum StateMachineState {
 384 #define SMS_DEF_ENUM(s) sm_##s,
 385   SMS_LIST(SMS_DEF_ENUM)
 386 };
 387
 388 static const char *sms_names[]= {
 389 #define SMS_DEF_NAME(s) #s ,
 390   SMS_LIST(SMS_DEF_NAME)
 391   0
 392 };
 393
 394 struct Conn {
 395   ISNODE(Conn);
 396   int fd, max_queue, stream, quitting;
 397   ArticleList queue; /* not yet told peer, or CHECK said send it */
 398   ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
 399   struct iovec xmit[CONNIOVS];
 400   XmitDetails xmitd[CONNIOVS];
 401   int xmitu;
 402 };
 403
 404
 405 /*----- operational variables -----*/
 406
 407 static oop_source *loop;
 408
 409 static int until_connect;
 410 static ConnList conns;
 411 static ArticleList queue;
 412
 413 static char *path_lock, *path_flushing, *path_defer;
 414
 415 #define SMS(newstate, periods, why) \
 416    (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
 417
 418 static StateMachineState sms;
 419 static FILE *defer;
 420 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
 421 static int sm_period_counter;
 422
 423
 424 /*========== logging ==========*/
 425
 426 static void logcore(int sysloglevel, const char *fmt, ...)
 427      __attribute__((__format__(printf,2,3)));
 428 static void logcore(int sysloglevel, const char *fmt, ...) {
 429   va_list al;
 430   va_start(al,fmt);
 431   if (become_daemon) {
 432     vsyslog(sysloglevel,fmt,al);
 433   } else {
 434     vfprintf(stderr,fmt,al);
 435     putc('\n',stderr);
 436   }
 437   va_end(al);
 438 }
 439
 440 static void logv(int sysloglevel, const char *pfx, int errnoval,
 441                  int exitstatus, const char *fmt, va_list al)
 442      __attribute__((__format__(printf,5,0)));
 443 static void logv(int sysloglevel, const char *pfx, int errnoval,
 444                  int exitstatus, const char *fmt, va_list al) {
 445   char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
 446   vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
 447   msgbuf[sizeof(msgbuf)-1]= 0;
 448
 449   if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
 450     sysloglevel= LOG_ERR; /* run by wrong user, probably */
 451
 452   logcore(sysloglevel, "<%s>%s: %s%s%s",
 453          sitename, pfx, msgbuf,
 454          errnoval>=0 ? ": " : "",
 455          errnoval>=0 ? strerror(errnoval) : "");
 456 }
 457
 458 #define logwrap(fn, pfx, sysloglevel, err, estatus)     \
 459   static void fn(const char *fmt, ...)                  \
 460       __attribute__((__format__(printf,1,2)));          \
 461   static void fn(const char *fmt, ...) {                \
 462     va_list al;                                         \
 463     va_start(al,fmt);                                   \
 464     logv(sysloglevel, pfx, err, estatus, fmt, al);      \
 465   }
 466
 467 logwrap(sysdie,   " critical", LOG_CRIT,    errno, 16);
 468 logwrap(die,      " critical", LOG_CRIT,    -1,    16);
 469
 470 logwrap(sysfatal, " fatal",    LOG_ERR,     errno, 12);
 471 logwrap(fatal,    " fatal",    LOG_ERR,     -1,    12);
 472
 473 logwrap(syswarn,  " warning",  LOG_WARNING, errno, 0);
 474 logwrap(warn,     " warning",  LOG_WARNING, -1,    0);
 475
 476 logwrap(notice,   "",          LOG_NOTICE,  -1,    0);
 477 logwrap(info,     " info",     LOG_INFO,    -1,    0);
 478 logwrap(debug,    " debug",    LOG_DEBUG,   -1,    0);
 479
 480
 481 /*========== utility functions etc. ==========*/
 482
 483 static char *xvasprintf(const char *fmt, va_list al)
 484      __attribute__((__format__(printf,1,0)));
 485 static char *xvasprintf(const char *fmt, va_list al) {
 486   char *str;
 487   int rc= vasprintf(&str,fmt,al);
 488   if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
 489   return str;
 490 }
 491 static char *xasprintf(const char *fmt, ...)
 492      __attribute__((__format__(printf,1,2)));
 493 static char *xasprintf(const char *fmt, ...) {
 494   va_list al;
 495   va_start(al,fmt);
 496   char *str= xvasprintf(fmt,al);
 497   va_end(al);
 498   return str;
 499 }
 500
 501 static void perhaps_close(int *fd) { if (*fd) { close(*fd); fd=0; } }
 502
 503 static pid_t xfork(const char *what) {
 504   pid_t child;
 505
 506   child= fork();
 507   if (child==-1) sysdie("cannot fork for %s",what);
 508   if (!child) postfork(what);
 509   debug("forked %s %ld", what, (unsigned long)child);
 510   return child;
 511 }
 512
 513 static void on_fd_read_except(int fd, oop_call_fd callback) {
 514   loop->on_fd(loop, fd, OOP_READ,      callback, 0);
 515   loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
 516 }
 517 static void cancel_fd_read_except(int fd) {
 518   loop->cancel_fd(loop, fd, OOP_READ);
 519   loop->cancel_fd(loop, fd, OOP_EXCEPTION);
 520 }
 521
 522 static void report_child_status(const char *what, int status) {
 523   if (WIFEXITED(status)) {
 524     int es= WEXITSTATUS(status);
 525     if (es)
 526       warn("%s: child died with error exit status %d",es);
 527   } else if (WIFSIGNALED(status)) {
 528     int sig= WTERMSIG(status);
 529     const char *sigstr= strsignal(sig);
 530     const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
 531     if (sigstr)
 532       warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
 533     else
 534       warn("%s: child died due to unknown fatal signal %d%s",
 535            what, sig, coredump);
 536   } else {
 537     warn("%s: child died with unknown wait status %d", status);
 538   }
 539 }
 540
 541 static int xwaitpid(pid_t *pid, const char *what) {
 542   int status;
 543
 544   int r= kill(*pid, SIGKILL);
 545   if (r) sysdie("cannot kill %s child", what);
 546
 547   pid_t got= waitpid(*pid, &status, WNOHANG);
 548   if (got==-1) sysdie("cannot reap %s child", what);
 549
 550   *pid= 0;
 551
 552   return status;
 553 }
 554
 555 static void xunlink(const char *path, const char *what) {
 556   int r= unlink(path);
 557   if (r) sysdie("can't unlink %s %s", path, what);
 558 }
 559
 560 static void check_isreg(const struct stat *stab, const char *path,
 561                         const char *what) {
 562   if (!S_ISREG(stab->st_mode))
 563     die("%s %s not a plain file (mode 0%lo)",
 564         what, path, (unsigned long)stab->st_mode);
 565 }
 566
 567 static void xfstat(int fd, struct stat *stab_r, const char *what) {
 568   int r= fstat(fd, stab_r);
 569   if (r) sysdie("could not fstat %s", what);
 570 }
 571
 572 static void xfstat_isreg(int fd, struct stat *stab_r,
 573                          const char *path, const char *what) {
 574   xfstat(fd, stab_r, what);
 575   check_isreg(stab_r, path, what);
 576 }
 577
 578 static void xlstat_isreg(const char *path, struct stat *stab,
 579                          int *enoent_r /* 0 means ENOENT is fatal */,
 580                          const char *what) {
 581   int r= lstat(path, stab);
 582   if (r) {
 583     if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
 584     sysdie("could not lstat %s %s", what, path);
 585   }
 586   if (enoent_r) *enoent_r= 0;
 587   check_isreg(stab, path, what);
 588 }
 589
 590 static void setnonblock(int fd, int nonblocking) {
 591   int r= fcntl(fd, F_GETFL);  if (r<0) sysdie("setnonblocking fcntl F_GETFL");
 592   if (nonblocking) r |= O_NONBLOCK;
 593   else r &= ~O_NONBLOCK;
 594   r= fcntl(fd, F_SETFL, r);  if (r<0) sysdie("setnonblocking fcntl F_SETFL");
 595 }
 596
 597 static int samefile(const struct stat *a, const struct stat *b) {
 598   assert(S_ISREG(a->st_mode));
 599   assert(S_ISREG(b->st_mode));
 600   return (a->st_ino == b->st_ino &&
 601           a->st_dev == b->st_dev);
 602 }
 603
 604 static char *sanitise(const char *input) {
 605   static char sanibuf[100]; /* returns pointer to this buffer! */
 606
 607   const char *p= input;
 608   char *q= sanibuf;
 609   *q++= '`';
 610   for (;;) {
 611     if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
 612     int c= *p++;
 613     if (!c) { *q++= '\''; *q=0; break; }
 614     if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
 615     sprintf(q,"\\x%02x",c);
 616     q += 4;
 617   }
 618   return sanibuf;
 619 }
 620
 621 /*========== making new connections ==========*/
 622
 623 static void conn_dispose(Conn *conn) {
 624   if (!conn) return;
 625   perhaps_close(&conn->fd);
 626   free(conn);
 627   until_connect= reconnect_delay_periods;
 628 }
 629
 630 static int connecting_sockets[2]= {-1,-1};
 631 static pid_t connecting_child;
 632
 633 static void connect_attempt_discard(void) {
 634   if (connecting_sockets[0])
 635     cancel_fd_read_except(connecting_sockets[0]);
 636
 637   perhaps_close(&connecting_sockets[0]);
 638   perhaps_close(&connecting_sockets[1]);
 639
 640   if (connecting_child) {
 641     int r= kill(connecting_child, SIGTERM);
 642     if (r) syswarn("failed to kill connecting child");
 643     int status= xwaitpid(&connecting_child, "connect");
 644
 645     if (!(WIFEXITED(status) ||
 646           (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
 647       report_child_status("connect", status);
 648   }
 649 }
 650
 651 #define PREP_DECL_MSG_CMSG(msg)                 \
 652   struct msghdr msg;                            \
 653   memset(&msg,0,sizeof(msg));                   \
 654   char msg##cbuf[CMSG_SPACE(sizeof(fd))];       \
 655   msg.msg_control= msg##cbuf;                   \
 656   msg.msg_controllen= sizeof(msg##cbuf);
 657
 658 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
 659   Conn *conn= 0;
 660
 661   conn= xmalloc(sizeof(*conn));
 662   memset(conn,0,sizeof(*conn));
 663
 664   PREP_DECL_MSG_CMSG(msg);
 665   struct cmsghdr *h= 0;
 666   ssize_t rs= recvmsg(fd, &msg, MSG_DONTWAIT);
 667   if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
 668   if (!h) {
 669     int status;
 670     pid_t got= waitpid(connecting_child, &status, WNOHANG);
 671     if (got != -1) {
 672       assert(got==connecting_child);
 673       connecting_child= 0;
 674       if (WIFEXITED(status) &&
 675           (WEXITSTATUS(status) != 0 &&
 676            WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
 677            WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)) {
 678         /* child already reported the problem */
 679       } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
 680         warn("connect: connection attempt timed out");
 681       } else if (!WIFEXITED(status)) {
 682         report_child_status("connect", status);
 683         /* that's probably the root cause then */
 684       }
 685     } else {
 686       /* child is still running apparently, report the socket problem */
 687       if (rs < 0)
 688         syswarn("connect: read from child socket failed");
 689       else if (e == OOP_EXCEPTION)
 690         warn("connect: unexpected exception on child socket");
 691       else
 692         warn("connect: unexpected EOF on child socket");
 693     }
 694     goto x;
 695   }
 696
 697 #define CHK(field, val)                                                   \
 698   if (h->cmsg_##field != val) {                                           \
 699     die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d"); \
 700     goto x;                                                               \
 701   }
 702   CHK(level, SOL_SOCKET);
 703   CHK(type,  SCM_RIGHTS);
 704   CHK(len,   CMSG_LEN(sizeof(conn->fd)));
 705 #undef CHK
 706
 707   if (CMSG_NXTHDR(&msg,h)) { die("connect: child sent many cmsgs"); goto x; }
 708
 709   memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
 710
 711   int status;
 712   pid_t got= waitpid(connecting_child, &status, 0);
 713   if (got==-1) sysdie("connect: real wait for child");
 714   assert(got == connecting_child);
 715   connecting_child= 0;
 716
 717   if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
 718   int es= WEXITSTATUS(status);
 719   switch (es) {
 720   case CONNCHILD_ESTATUS_STREAM:    conn->stream= 1;   break;
 721   case CONNCHILD_ESTATUS_NOSTREAM:  conn->stream= 0;   break;
 722   default:
 723     fatal("connect: child gave unexpected exit status %d", es);
 724   }
 725
 726   /* Phew! */
 727   setnonblock(conn->fd, 1);
 728   conn->max_queue= conn->stream ? max_queue_per_conn : 1;
 729   LIST_ADDHEAD(conns, conn);
 730   notice("#%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
 731   connect_attempt_discard();
 732   check_master_queue();
 733   return 0;
 734
 735  x:
 736   conn_dispose(conn);
 737   connect_attempt_discard();
 738 }
 739
 740 static void connect_start(void) {
 741   assert(!connecting_sockets[0]);
 742   assert(!connecting_sockets[1]);
 743   assert(!connecting_child);
 744
 745   notice("starting connection attempt");
 746
 747   int r= socketpair(AF_UNIX, SOCK_STREAM, 0, connecting_sockets);
 748   if (r) { syswarn("connect: cannot create socketpair for child"); goto x; }
 749
 750   connecting_child= xfork("connection");
 751
 752   if (!connecting_child) {
 753     FILE *cn_from, *cn_to;
 754     char buf[NNTP_STRLEN+100];
 755     int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
 756
 757     r= close(connecting_sockets[0]);
 758     if (r) sysdie("connect: close parent socket in child");
 759
 760     alarm(connection_setup_timeout);
 761     if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
 762       if (buf[0]) fatal("connect: rejected: %s", sanitise(buf));
 763       else sysfatal("connect: connection attempt failed");
 764     }
 765     if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
 766       sysfatal("connect: authentication failed");
 767     if (try_stream) {
 768       if (fputs("MODE STREAM\r\n", cn_to) ||
 769           fflush(cn_to))
 770         sysfatal("connect: could not send MODE STREAM");
 771       buf[sizeof(buf)-1]= 0;
 772       if (!fgets(buf, sizeof(buf)-1, cn_from)) {
 773         if (ferror(cn_from))
 774           sysfatal("connect: could not read response to MODE STREAM");
 775         else
 776           fatal("connect: connection close in response to MODE STREAM");
 777       }
 778       int l= strlen(buf);
 779       assert(l>=1);
 780       if (buf[-1]!='\n')
 781         fatal("connect: response to MODE STREAM is too long: %.100s...",
 782             remote_host, sanitise(buf));
 783       l--;  if (l>0 && buf[l-1]=='\r') l--;
 784       buf[l]= 0;
 785       char *ep;
 786       int rcode= strtoul(buf,&ep,10);
 787       if (ep != &buf[3])
 788         fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf));
 789
 790       switch (rcode) {
 791       case 203:
 792         exitstatus= CONNCHILD_ESTATUS_STREAM;
 793         break;
 794       case 480:
 795       case 500:
 796         break;
 797       default:
 798         warn("connect: unexpected response to MODE STREAM: %.50s",
 799              sanitise(buf));
 800         exitstatus= 2;
 801         break;
 802       }
 803     }
 804     int fd= fileno(cn_from);
 805
 806     PREP_DECL_MSG_CMSG(msg);
 807     struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
 808     cmsg->cmsg_level= SOL_SOCKET;
 809     cmsg->cmsg_type=  SCM_RIGHTS;
 810     cmsg->cmsg_len=   CMSG_LEN(sizeof(fd));
 811     memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
 812
 813     msg.msg_controllen= cmsg->cmsg_len;
 814     r= sendmsg(connecting_sockets[1], &msg, 0);
 815     if (r) sysdie("sendmsg failed for new connection");
 816
 817     _exit(exitstatus);
 818   }
 819
 820   r= close(connecting_sockets[1]);  connecting_sockets[1]= 0;
 821   if (r) sysdie("connect: close child socket in parent");
 822
 823   on_fd_read_except(connecting_sockets[0], connchild_event);
 824   return;
 825
 826  x:
 827   connect_attempt_discard();
 828 }
 829
 830
 831 /*========== overall control of article flow ==========*/
 832
 833 static void check_master_queue(void) {
 834   for (;;) {
 835     if (!queue.count)
 836       break;
 837
 838     Conn *walk, *use=0;
 839     int spare;
 840     for (walk=LIST_HEAD(conns); walk; walk=LIST_NEXT(walk)) {
 841       int inqueue= walk->sent.count + walk->queue.count;
 842       spare= walk->max_queue - inqueue;
 843       assert(inqueue <= max_queue_per_conn);
 844       assert(spare >= 0);
 845       if (inqueue==0) /*idle*/ { if (!use) use= walk; }
 846       else if (spare>0) /*working*/ { use= walk; break; }
 847     }
 848     if (use) {
 849       while (spare>0) {
 850         Article *art= LIST_REMHEAD(queue);
 851         LIST_ADDTAIL(use->queue, art);
 852         spare--;
 853       }
 854       conn_maybe_write(use);
 855     } else if (conns.count < max_connections &&
 856              !connecting_child && !until_connect) {
 857       until_connect= reconnect_delay_periods;
 858       connect_start();
 859       break;
 860     } else {
 861       break;
 862     }
 863   }
 864 }
 865
 866 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
 867   conn_maybe_write(u);
 868   return OOP_CONTINUE;
 869 }
 870
 871 static void conn_maybe_write(Conn *conn)  {
 872   void *rp= 0;
 873   for (;;) {
 874     conn_make_some_xmits(conn);
 875     if (!conn->xmitu) {
 876       loop->cancel_fd(loop, conn->fd, OOP_WRITE);
 877       return;
 878     }
 879
 880     void *rp= conn_write_some_xmits(conn);
 881     if (rp==OOP_CONTINUE) {
 882       loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
 883       return;
 884     } else if (rp==OOP_HALT) {
 885       return;
 886     } else if (!rp) {
 887       /* transmitted everything */
 888     } else {
 889       abort();
 890     }
 891   }
 892 }
 893
 894 static void vconnfail(Conn *conn, const char *fmt, va_list al)
 895      __attribute__((__format__(printf,2,0)));
 896
 897 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
 898   int requeue[art_MaxState];
 899
 900   Article *art;
 901   while ((art= LIST_REMHEAD(conn->queue))) LIST_ADDTAIL(queue, art);
 902   while ((art= LIST_REMHEAD(conn->sent))) {
 903     requeue[art->state]++;
 904     if (art->state==art_Unsolicited) art->state= art_Unchecked;
 905     LIST_ADDTAIL(queue,art);
 906   }
 907
 908   int i;
 909   XmitDetails *d;
 910   for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
 911     xmit_free(d);
 912
 913   char *m= xvasprintf(fmt,al);
 914   warn("#%d connection failed, requeueing " RCI_TRIPLE_FMT_BASE ": %s",
 915        conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
 916   free(m);
 917
 918   LIST_REMOVE(conns,conn);
 919   conn_dispose(conn);
 920   check_master_queue();
 921 }
 922
 923 static void connfail(Conn *conn, const char *fmt, ...)
 924      __attribute__((__format__(printf,2,3)));
 925 static void connfail(Conn *conn, const char *fmt, ...) {
 926   va_list al;
 927   va_start(al,fmt);
 928   vconnfail(conn,fmt,al);
 929   va_end(al);
 930 }
 931
 932 /*========== article transmission ==========*/
 933
 934 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
 935                   XmitKind kind) { /* caller must then fill in details */
 936   struct iovec *v= &conn->xmit[conn->xmitu];
 937   XmitDetails *d= &conn->xmitd[conn->xmitu++];
 938   v->iov_base= (char*)data;
 939   v->iov_len= len;
 940   d->kind= kind;
 941   return d;
 942 }
 943
 944 static void xmit_noalloc(Conn *conn, const char *data, int len) {
 945   xmit_core(conn,data,len, xk_Const);
 946 }
 947 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
 948
 949 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
 950   XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
 951   d->info.sm_art= ah;
 952 }
 953
 954 static void xmit_free(XmitDetails *d) {
 955   switch (d->kind) {
 956   case xk_Malloc:  free(d->info.malloc_tofree);   break;
 957   case xk_Artdata: SMfreearticle(d->info.sm_art); break;
 958   case xk_Const:                                  break;
 959   default: abort();
 960   }
 961 }
 962
 963 static void *conn_write_some_xmits(Conn *conn) {
 964   /* return values:
 965    *      0:            nothing more to write, no need to call us again
 966    *      OOP_CONTINUE: more to write but fd not writeable
 967    *      OOP_HALT:     disaster, have destroyed conn
 968    */
 969   for (;;) {
 970     int count= conn->xmitu;
 971     if (!count) return 0;
 972
 973     if (count > IOV_MAX) count= IOV_MAX;
 974     ssize_t rs= writev(conn->fd, conn->xmit, count);
 975     if (rs < 0) {
 976       if (errno == EAGAIN) return OOP_CONTINUE;
 977       connfail(conn, "write failed: %s", strerror(errno));
 978       return OOP_HALT;
 979     }
 980     assert(rs > 0);
 981
 982     int done;
 983     for (done=0; rs && done<conn->xmitu; done++) {
 984       struct iovec *vp= &conn->xmit[done];
 985       XmitDetails *dp= &conn->xmitd[done];
 986       if (rs > vp->iov_len) {
 987         rs -= vp->iov_len;
 988         xmit_free(dp);
 989       } else {
 990         vp->iov_base += rs;
 991         vp->iov_len -= rs;
 992       }
 993     }
 994     int newu= conn->xmitu - done;
 995     memmove(conn->xmit,  conn->xmit  + done, newu * sizeof(*conn->xmit));
 996     memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
 997     conn->xmitu= newu;
 998   }
 999 }
1000
1001 static void conn_make_some_xmits(Conn *conn) {
1002   for (;;) {
1003     if (conn->xmitu+5 > CONNIOVS)
1004       break;
1005
1006     Article *art= LIST_REMHEAD(queue);
1007     if (!art) break;
1008
1009     if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1010       /* actually send it */
1011
1012       ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1013
1014       if (conn->stream) {
1015         if (artdata) {
1016           XMIT_LITERAL("TAKETHIS ");
1017           xmit_noalloc(conn, art->messageid, art->midlen);
1018           XMIT_LITERAL("\r\n");
1019           xmit_artbody(conn, artdata);
1020         }
1021       } else {
1022         /* we got 235 from IHAVE */
1023         if (artdata) {
1024           xmit_artbody(conn, artdata);
1025         } else {
1026           XMIT_LITERAL(".\r\n");
1027         }
1028       }
1029
1030       art->state=
1031         art->state == art_Unchecked ? art_Unsolicited :
1032         art->state == art_Wanted    ? art_Wanted      :
1033         (abort(),-1);
1034       art->ipf->counts[art->state][RC_sent]++;
1035       LIST_ADDTAIL(conn->sent, art);
1036
1037     } else {
1038       /* check it */
1039
1040       if (conn->stream)
1041         XMIT_LITERAL("IHAVE ");
1042       else
1043         XMIT_LITERAL("CHECK ");
1044       xmit_noalloc(conn, art->messageid, art->midlen);
1045       XMIT_LITERAL("\r\n");
1046
1047       assert(art->state == art_Unchecked);
1048       art->ipf->counts[art->state][RCI_sent]++;
1049       LIST_ADDTAIL(conn->sent, art);
1050     }
1051   }
1052 }
1053
1054
1055 /*========== handling responses from peer ==========*/
1056
1057 static const oop_rd_style peer_rd_style= {
1058   OOP_RD_DELIM_STRIP, '\n',
1059   OOP_RD_NUL_FORBID,
1060   OOP_RD_SHORTREC_FORBID
1061 };
1062
1063 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_event ev,
1064                          const char *errmsg, int errnoval,
1065                          const char *data, size_t recsz, void *conn_v) {
1066   Conn *conn= conn_v;
1067   connfail(conn, "error receiving from peer: %s", errmsg);
1068   return OOP_CONTINUE;
1069 }
1070
1071 static Article *article_reply_check(Conn *conn, const char *response,
1072                                     int code_indicates_streaming,
1073                                     int must_have_sent
1074                                         /* 1:yes, -1:no, 0:dontcare */,
1075                                     const char *sanitised_response) {
1076   Article *art= LIST_HEAD(conn->sent);
1077
1078   if (!art) {
1079     connfail(conn,
1080              "peer gave unexpected response when no commands outstanding: %s",
1081              sanitised_response);
1082     return 0;
1083   }
1084
1085   if (code_indicates_streaming) {
1086     assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1087     if (!conn->stream) {
1088       connfail(conn, "peer gave streaming response code "
1089                " to IHAVE or subsequent body: %s", sanitised_response);
1090       return 0;
1091     }
1092     const char *got_mid= response+4;
1093     int got_midlen= strcspn(got_mid, " \n\r");
1094     if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1095       connfail(conn, "peer gave streaming response with syntactically invalid"
1096                " messageid: %s", sanitised_response);
1097       return 0;
1098     }
1099     if (got_midlen != art->midlen ||
1100         memcmp(got_mid, art->messageid, got_midlen)) {
1101       connfail(conn, "peer gave streaming response code to wrong article -"
1102                " probable synchronisation problem; we offered: %s;"
1103                " peer said: %s",
1104                art->messageid, sanitised_response);
1105       return 0;
1106     }
1107   } else {
1108     if (conn->stream) {
1109       connfail(conn, "peer gave non-streaming response code to"
1110                " CHECK/TAKETHIS: %s", sanitised_response);
1111       return 0;
1112     }
1113   }
1114
1115   if (must_have_sent>0 && art->state < art_Wanted) {
1116     connfail(conn, "peer says article accepted but"
1117              " we had not sent the body: %s", sanitised_response);
1118     return 0;
1119   }
1120   if (must_have_sent<0 && art->state >= art_Wanted) {
1121     connfail(conn, "peer says please sent the article but we just did: %s",
1122              sanitised_response);
1123     return 0;
1124   }
1125
1126   Article *art_again= LIST_REMHEAD(conn->sent);
1127   assert(art_again == art);
1128   return art;
1129 }
1130
1131 static void update_nocheck(int accepted) {
1132   accept_proportion *= nocheck_decay;
1133   accept_proportion += accepted * (1.0 - nocheck_decay);
1134   int new_nocheck= accept_proportion >= nocheck_thresh;
1135   if (new_nocheck && !nocheck_reported) {
1136     notice("entering nocheck mode for the first time");
1137     nocheck_reported= 1;
1138   } else if (new_nocheck != nocheck) {
1139     debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1140   }
1141   nocheck= new_nocheck;
1142 }
1143
1144 static void article_done(Conn *conn, Article *art, int whichcount) {
1145   art->ipf->counts[art->state][whichcount]++;
1146   if (whichcount == RC_accepted) update_nocheck(1);
1147   else if (whichcount == RC_unwanted) update_nocheck(0);
1148
1149   InputFile *ipf= art->ipf;
1150   while (art->blanklen) {
1151     static const char spaces[]=
1152       "                                                                "
1153       "                                                                "
1154       "                                                                "
1155       "                                                                ";
1156     int w= art->blanklen;  if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1157     int r= pwrite(ipf->fd, spaces, w, art->offset);
1158     if (r==-1) {
1159       if (errno==EINTR) continue;
1160       sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1161              art->messageid, art->blanklen, art->offset, ipf->path);
1162     }
1163     assert(r>=0 && r<=w);
1164     art->blanklen -= w;
1165     art->offset += w;
1166   }
1167
1168   ipf->inprogress--;
1169   assert(ipf->inprogress >= 0);
1170
1171   if (!ipf->inprogress && ipf != main_input_file)
1172     queue_check_input_done();
1173
1174   free(art);
1175 }
1176
1177 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
1178                         const char *errmsg, int errnoval,
1179                         const char *data, size_t recsz, void *conn_v) {
1180   Conn *conn= conn_v;
1181
1182   if (ev == OOP_RD_EOF) {
1183     connfail(conn, "unexpected EOF from peer");
1184     return OOP_CONTINUE;
1185   }
1186   assert(ev == OOP_RD_OK);
1187
1188   char *sani= sanitise(data);
1189
1190   char *ep;
1191   unsigned long code= strtoul(data, &ep, 10);
1192   if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1193     connfail(conn, "badly formatted response from peer: %s", sani);
1194     return OOP_CONTINUE;
1195   }
1196
1197   if (conn->quitting) {
1198     if (code!=205 && code!=503) {
1199       connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1200     } else {
1201       notice("#%d idle connection closed\n");
1202       assert(!conn->queue.count);
1203       assert(!conn->sent.count);
1204       assert(!conn->xmitu);
1205       LIST_REMOVE(conns,conn);
1206       conn_dispose(conn);
1207     }
1208     return OOP_CONTINUE;
1209   }
1210
1211   Article *art;
1212
1213 #define GET_ARTICLE(musthavesent)                                           \
1214   art= article_reply_check(conn, data, musthavesent, code_streaming, sani); \
1215   if (art) ; else return OOP_CONTINUE /* reply_check has failed the conn */
1216
1217 #define ARTICLE_DEALTWITH(streaming,musthavesent,how)           \
1218   code_streaming= (streaming);                                  \
1219   GET_ARTICLE(musthavesent);                                    \
1220   article_done(conn, art, RC_##how);  break;
1221
1222 #define PEERBADMSG(m) connfail(conn, m ": %s", sani);  return OOP_CONTINUE
1223
1224   int code_streaming= 0;
1225
1226   switch (code) {
1227
1228   case 400: PEERBADMSG("peer stopped accepting articles");
1229   case 503: PEERBADMSG("peer timed us out");
1230   default:  PEERBADMSG("peer sent unexpected message");
1231
1232   case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1233   case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1234
1235   case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1236   case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1237
1238   case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1239   case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1240
1241   case 238: /* CHECK says send it */
1242     code_streaming= 1;
1243   case 335: /* IHAVE says send it */
1244     GET_ARTICLE(-1);
1245     assert(art->state == art_Unchecked);
1246     art->ipf->counts[art->state][RC_accepted]++;
1247     art->state= art_Wanted;
1248     LIST_ADDTAIL(conn->queue, art);
1249     break;
1250
1251   case 431: /* CHECK or TAKETHIS says try later */
1252     code_streaming= 1;
1253   case 436: /* IHAVE says try later */
1254     GET_ARTICLE(0);
1255     open_defer();
1256     if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1257         || fflush(defer))
1258       sysfatal("write to defer file %s",path_defer);
1259     article_done(conn, art, RC_deferred);
1260     break;
1261
1262   }
1263
1264   conn_maybe_write(sendon);
1265   check_master_queue();
1266   return OOP_CONTINUE;
1267 }
1268
1269
1270 /*========== monitoring of input files ==========*/
1271
1272 static void feedfile_eof(InputFile *ipf) {
1273   assert(ipf != main_input_file); /* promised by tailing_try_read */
1274
1275   inputfile_tailing_stop(ipf);
1276   assert(ipf->fd >= 0);
1277   if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1278   ipf->fd= -1;
1279
1280   if (ipf == flushing_input_file) {
1281     assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1282     if (main_input_file) inputfile_tailing_start(main_input_file);
1283     statemc_check_flushing_done();
1284   } else if (ipf == backlog_input_file) {
1285     statemc_check_backlog_done();
1286   } else {
1287     abort(); /* supposed to wait rather than get EOF on main input file */
1288   }
1289 }
1290
1291 static InputFile *open_input_file(const char *path) {
1292   int fd= open(path, O_RDONLY);
1293   if (fd<0) {
1294     if (errno==ENOENT) return 0;
1295     sysfatal("unable to open input file %s", path);
1296   }
1297
1298   InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
1299   memset(ipf,0,sizeof(*ipf));
1300
1301   ipf->readable.on_readable= tailing_on_readable;
1302   ipf->readable.on_cancel=   tailing_on_cancel;
1303   ipf->readable.try_read=    tailing_try_read;
1304
1305   ipf->fd= fd;
1306   strcpy(ipf->path, path);
1307
1308   return ipf;
1309 }
1310
1311 static void close_input_file(InputFile *ipf) {
1312   assert(!ipf->readable_callback); /* must have had ->on_cancel */
1313   assert(!ipf->filemon); /* must have had inputfile_tailing_stop */
1314   assert(!ipf->rd); /* must have had inputfile_tailing_stop */
1315   assert(!ipf->inprogress); /* no dangling pointers pointing here */
1316
1317   if (ipf->fd >= 0)
1318     if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1319 }
1320
1321
1322 /*---------- dealing with articles read in the input file ----------*/
1323
1324 typedef void *feedfile_got_article(oop_source *lp, oop_read *rd,
1325                                    oop_rd_event ev, const char *errmsg,
1326                                    int errnoval,
1327                                    const char *data, size_t recsz,
1328                                    void *ipf_v) {
1329   InputFile *ipf= ipf_v;
1330   Article *art;
1331   char tokentextbuf[sizeof(TOKEN)*2+3];
1332
1333   if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
1334
1335   if (data[0] && data[0]!=' ') {
1336     char *space= strchr(data,' ');
1337     int tokenlen= space-data;
1338     int midlen= (int)recsz-tokenlen-1;
1339     if (midlen < 0) goto bad_data;
1340
1341     if (tokenlen != sizeof(TOKEN)*2+2) goto bad_data;
1342     memcpy(tokentextbuf, data, tokenlen);
1343     tokentextbuf[tokenlen]= 0;
1344     if (!IsToken(tokentextbuf)) goto bad_data;
1345
1346     art= xmalloc(sizeof(*art) - 1 + midlen + 1);
1347     art->offset= ipf->offset;
1348     art->blanklen= recsz;
1349     art->midlen= midlen;
1350     art->state= art_Unchecked;
1351     art->ipf= ipf;  ipf->inprogress++;
1352     art->token= TextToToken(tokentextbuf);
1353     strcpy(art->messageid, space+1);
1354     LIST_ADDTAIL(queue, art);
1355   }
1356   ipf->offset += recsz + 1;
1357
1358   if (sms==sm_NORMAL && ipf==main_input_file &&
1359       ipf->offset >= flush_threshold)
1360     statemc_start_flush("feed file size");
1361
1362   check_master_queue();
1363 }
1364
1365 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
1366   assert(sms == sm_NORMAL);
1367
1368   debug("starting flush (%s) (%lu >= %lu) (%d)",
1369         why,
1370         (unsigned long)ipf->offset, (unsigned long)flush_threshold,
1371         sm_period_counter);
1372
1373   int r= link(feedfile, duct_path);
1374   if (r) sysdie("link feedfile %s to flushing file %s", feedfile,
1375                 path_duct);
1376   /* => Hardlinked */
1377
1378   xunlink(feedfile, "old feedfile link");
1379   /* => Moved */
1380
1381   spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
1382 }
1383
1384 /*========== tailing input file ==========*/
1385
1386 static void filemon_start(InputFile *ipf) {
1387   assert(!ipf->filemon);
1388
1389   ipf->filemon= xmalloc(sizeof(*ipf->filemon));
1390   memset(ipf->filemon, 0, sizeof(*ipf->filemon));
1391   filemon_method_startfile(ipf, ipf->filemon);
1392 }
1393
1394 static void filemon_stop(InputFile *ipf) {
1395   if (!ipf->filemon) return;
1396   filemon_method_stopfile(ipf, ipf->filemon);
1397   free(ipf->filemon);
1398   ipf->filemon= 0;
1399 }
1400
1401 static void filemon_callback(InputFile *ipf) {
1402   ipf->readable_callback(ipf->readable_callback_user);
1403 }
1404
1405 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
1406                                      void *user) {
1407   InputFile *ipf= user;
1408   return ipf->readable_callback(ipf->readable_callback_user);
1409 }
1410
1411 static void on_cancel(struct oop_readable *rable) {
1412   InputFile *ipf= (void*)rable;
1413
1414   if (ipf->filemon) filemon_stopfile(ipf);
1415   loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1416   ipf->readable_callback= 0;
1417 }
1418
1419 static void tailing_queue_readable(InputFile *ipf) {
1420   /* lifetime of ipf here is OK because destruction will cause
1421    * on_cancel which will cancel this callback */
1422   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1423 }
1424
1425 static int tailing_on_readable(struct oop_readable *rable,
1426                                 oop_readable_call *cb, void *user) {
1427   InputFile *ipf= (void*)rable;
1428
1429   tailing_on_cancel(rable);
1430   ipf->readable_callback= cb;
1431   ipf->readable_callback_user= user;
1432   filemon_startfile(ipf);
1433
1434   tailing_queue_readable(ipf);
1435   return 0;
1436 }
1437
1438 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
1439                                 size_t length) {
1440   InputFile *ipf= (void*)rable;
1441   for (;;) {
1442     ssize_t r= read(ipf->fd, buffer, length);
1443     if (r==-1) {
1444       if (errno==EINTR) continue;
1445       return r;
1446     }
1447     if (!r) {
1448       if (ipf==main_input_file) {
1449         errno=EAGAIN;
1450         return -1;
1451       } else if (ipf==flushing_input_file) {
1452         assert(ipf->fd>=0);
1453         assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1454       } else if (ipf==backlog_input_file) {
1455         assert(ipf->fd>=0);
1456       } else {
1457         abort();
1458       }
1459     }
1460     return r;
1461   }
1462 }
1463
1464 /*---------- filemon implemented with inotify ----------*/
1465
1466 #if defined(HAVE_INOTIFY) && !defined(HAVE_FILEMON)
1467 #define HAVE_FILEMON
1468
1469 #include <linux/inotify.h>
1470
1471 static int filemon_inotify_fd;
1472 static int filemon_inotify_wdmax;
1473 static InputFile **filemon_inotify_wd2ipf;
1474
1475 typedef struct Filemon_Perfile {
1476   int wd;
1477 } Filemon_Inotify_Perfile;
1478
1479 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
1480   int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
1481   if (wd < 0) sysdie("inotify_add_watch %s", ipf->path);
1482
1483   if (wd >= filemon_inotify_wdmax) {
1484     int newmax= wd+2;
1485     filemon_inotify_wd= xrealloc(filemon_inotify_wd2ipf,
1486                                  sizeof(*filemon_inotify_wd2ipf) * newmax);
1487     memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
1488            sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
1489     filemon_inotify_wdmax= newmax;
1490   }
1491
1492   assert(!filemon_inotify_wd2ipf[wd]);
1493   filemon_inotify_wd2ipf[wd]= ipf;
1494
1495   debug("filemon inotify startfile %p wd=%d wdmax=%d",
1496         ipf, wd, filemon_inotify_wdmax);
1497
1498   pf->wd= wd;
1499 }
1500
1501 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
1502   int wd= pf->wd;
1503   debug("filemon inotify stopfile %p wd=%d", ipf, wd);
1504   int r= inotify_rm_watch(filemon_inotify_fd, filemon_inotify_wd);
1505   if (r) sysdie("inotify_rm_watch");
1506   filemon_inotify_wd2ipf[wd]= 0;
1507 }
1508
1509 static void *filemon_inotify_readable(oop_source *lp, int fd,
1510                                       oop_event e, void *u) {
1511   struct inotify_event iev;
1512   for (;;) {
1513     int r= read(filemon_inotify_fd, &iev, sizeof(iev));
1514     if (r==-1) {
1515       if (errno==EAGAIN) break;
1516       sysdie("read from inotify master");
1517     } else if (r==sizeof(iev)) {
1518       assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
1519     } else {
1520       die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
1521     }
1522     InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
1523     debug("filemon inotify readable read %p wd=%p", iev.wd, ipf);
1524     filemon_callback(ipf);
1525   }
1526   return OOP_CONTINUE;
1527 }
1528
1529 static int filemon_method_init(void) {
1530   filemon_inotify_fd= inotify_init();
1531   if (filemon_inotify_fd<0) {
1532     syswarn("could not initialise inotify: inotify_init failed");
1533     return 0;
1534   }
1535   set nonblock;
1536   loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable);
1537
1538   debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
1539   return 1;
1540 }
1541
1542 #endif /* HAVE_INOTIFY && !HAVE_FILEMON *//
1543
1544 /*---------- filemon dummy implementation ----------*/
1545
1546 #if !defined(HAVE_FILEMON)
1547
1548 typedef struct Filemon_Perfile { int dummy; } Filemon_Dummy_Perfile;
1549
1550 static int filemon_method_init(void) { return 0; }
1551 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
1552 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
1553
1554 #endif /* !HAVE_FILEMON */
1555
1556 /*---------- interface to start and stop an input file ----------*/
1557
1558 static const oop_rd_style feedfile_rdstyle= {
1559   OOP_RD_DELIM_STRIP, '\n',
1560   OOP_RD_NUL_FORBID,
1561   OOP_RD_SHORTREC_EOF,
1562 };
1563
1564 static void inputfile_tailing_start(InputFile *ipf) {
1565   assert(!ipf->fd);
1566   ipf->readable->on_readable= tailing_on_readable;
1567   ipf->readable->on_cancel=   tailing_on_cancel;
1568   ipf->readable->try_read=    tailing_try_read;
1569   ipf->readable->delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
1570   ipf->readable->delete_kill= 0;
1571
1572   ipf->readable_callback= 0;
1573   ipf->readable_callback_user= 0;
1574
1575   ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
1576   assert(ipf->fd);
1577
1578   int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
1579                      feedfile_got_article,ipf, feedfile_problem,ipf);
1580   if (r) sysdie("unable start reading feedfile %s",ipf->path);
1581 }
1582
1583 static void inputfile_tailing_stop(InputFile *ipf) {
1584   assert(ipf->fd);
1585   oop_rd_cancel(ipf->rd);
1586   oop_rd_delete(ipf->rd);
1587   ipf->rd= 0;
1588   assert(!ipf->filemon); /* we shouldn't be monitoring it now */
1589 }
1590
1591
1592 /*========== interaction with innd - state machine ==========*/
1593
1594 /* See official state diagram at top of file.  We implement
1595  * this as follows:
1596  * -8<-
1597
1598             .=======.
1599             ||START||
1600             `======='
1601                 |
1602                 | open F
1603                 |
1604                 |    F ENOENT
1605                 |`---------------------------------------------------.
1606       F OPEN OK |                                                    |
1607                 |`---------------- - - -                             |
1608        D ENOENT |       D EXISTS   see OVERALL STATES diagram        |
1609                 |                  for full startup logic            |
1610      ,--------->|                                                    |
1611      |          V                                                    |
1612      |     ============                                       try to |
1613      |      NORMAL                                            open D |
1614      |     [Normal]                                                  |
1615      |      main F tail                                              |
1616      |     ============                                              V
1617      |          |                                                    |
1618      |          | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT            |
1619      ^          | hardlink F to D                                    |
1620      |     [Hardlinked]                                              |
1621      |          | unlink F                                           |
1622      |          | our handle onto F is now onto D                    |
1623      |     [Moved]                                                   |
1624      |          |                                                    |
1625      |          |<-------------------<---------------------<---------+
1626      |          |                                                    |
1627      |          | spawn inndcomm flush                               |
1628      |          V                                                    |
1629      |     ==================                                        |
1630      |      FLUSHING[-ABSENT]                                        |
1631      |     [Flushing]                                                |
1632      |     main D tail/none                                          |
1633      |     ==================                                        |
1634      |          |                                                    |
1635      |          |   INNDCOMM FLUSH FAILS                             ^
1636      |          |`----------------------->----------.                |
1637      |          |                                   |                |
1638      |          |   NO SUCH SITE                    V                |
1639      ^          |`--------------->----.         ==================== |
1640      |          |                      \        FLUSHFAILED[-ABSENT] |
1641      |          |                       \         [Moved]            |
1642      |          | FLUSH OK               \       main D tail/none    |
1643      |          | open F                  \     ==================== |
1644      |          |                          \        |                |
1645      |          |                           \       | TIME TO RETRY  |
1646      |          |`------->----.     ,---<---'\      `----------------'
1647      |          |    D NONE   |     | D NONE  `----.
1648      |          V             |     |              V
1649      |     =============      V     V             ============
1650      |      SEPARATED-1       |     |              DROPPING-1
1651      |      flsh->fd>=0       |     |              flsh->fd>=0
1652      |     [Separated]        |     |             [Dropping]
1653      |      main F idle       |     |              main none
1654      |      old D tail        |     |              old D tail
1655      |     =============      |     |             ============
1656      |          |             |     | install       |
1657      ^          | EOF ON D    |     |  defer        | EOF ON D
1658      |          V             |     |               V
1659      |     ===============    |     |             ===============
1660      |      SEPARATED-2       |     |              DROPPING-2
1661      |      flsh->fd==-1      |     V              flsh->fd==-1
1662      |     [Finishing]        |     |             [Dropping]
1663      |      main F tail       |     `.             main none
1664      |      old D closed      |       `.           old D closed
1665      |     ===============    V         `.        ===============
1666      |          |                         `.          |
1667      |          | ALL D PROCESSED           `.        | ALL D PROCESSED
1668      |          V install defer as backlog    `.      | install defer
1669      ^          | close D                       `.    | close D
1670      |          | unlink D                        `.  | unlink D
1671      |          |                                  |  |
1672      |          |                                  V  V
1673      `----------'                               ==============
1674                                                  DROPPED
1675                                                 [Dropped]
1676                                                  main none
1677                                                  old none
1678                                                  some backlog
1679                                                 ==============
1680                                                       |
1681                                                       | ALL BACKLOG DONE
1682                                                       |
1683                                                       | unlink lock
1684                                                       | exit
1685                                                       V
1686                                                   ==========
1687                                                    (ESRCH)
1688                                                   [Droppped]
1689                                                   ==========
1690  * ->8-
1691  */
1692
1693 static void statemc_init(void) {
1694   struct stat stab, stabf;
1695
1696   path_lock=        xasprintf("%s_lock",      feedfile);
1697   path_flushing=    xasprintf("%s_flushing",  feedfile);
1698   path_defer=       xasprintf("%s_defer",     feedfile);
1699   globpat_backlog=  xasprintf("%s_backlog*",  feedfile);
1700
1701   for (;;) {
1702     int lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
1703     if (lockfd<0) sysfatal("open lockfile %s", path_lock);
1704
1705     struct flock fl;
1706     memset(&fl,0,sizeof(fl));
1707     fl.l_type= F_WRLCK;
1708     fl.l_whence= SEEK_SET;
1709     r= fcntl(lockfd, F_SETLK, &fl);
1710     if (r==-1) {
1711       if (errno==EACCES || errno==EAGAIN) {
1712         if (quiet_multiple) exit(0);
1713         fatal("another duct holds the lockfile");
1714       }
1715       sysdie("fcntl F_SETLK lockfile %s", path_lock);
1716     }
1717
1718     xfstat_isreg(lockfd, &stabf, "lockfile");
1719     int lock_noent;
1720     xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
1721
1722     if (!lock_noent && samefile(&stab, &stabf))
1723       break;
1724
1725     if (close(lockfd))
1726       sysdie("could not close stale lockfile %s", path_lock);
1727   }
1728   debug("startup: locked");
1729
1730   search_backlog_file();
1731
1732   int defer_noent;
1733   xlstat_isreg(path_defer, &stab, &defer_noent, "defer file");
1734   if (defer_noent) {
1735     debug("startup: ductdefer ENOENT");
1736   } else {
1737     debug("startup: ductdefer nlink=%ld", (long)stab.st_nlink);
1738     switch (stab.st_nlink==1) {
1739     case 1:
1740       open_defer(); /* so that we will later close it and rename it */
1741       break;
1742     case 2:
1743       xunlink(path_defer, "stale defer file link"
1744               " (presumably hardlink to backlog file)");
1745       break;
1746     default:
1747       die("defer file %s has unexpected link count %d",
1748           path_defer, stab.st_nlink);
1749     }
1750   }
1751
1752   struct stat stab_f, stab_d;
1753   int noent_f;
1754
1755   InputFile *file_d= open_input_file(path_flushing);
1756   if (file_d) xfstat_isreg(file_d->fd, &stab_d, "flushing file");
1757
1758   xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
1759
1760   if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
1761     debug("startup: F==D => Hardlinked");
1762     xunlink(feedfile, "feed file (during startup)"); /* => Moved */
1763     noent_f= 1;
1764   }
1765
1766   if (noent_f) {
1767     debug("startup: F ENOENT => Moved");
1768     if (file_d) startup_set_input_file(file_d);
1769     spawn_inndcomm_flush("feedfile missing at startup");
1770     /* => Flushing, sms:=FLUSHING */
1771   } else {
1772     if (file_d) {
1773       debug("startup: F!=D => Separated");
1774       startup_set_input_file(file_d);
1775       SMS(SEPARATED, 0, "found both old and current feed files");
1776     } else {
1777       debug("startup: F exists, D ENOENT => Normal");
1778       FILE *file_f= open_input_file(feedfile);
1779       if (!file_f) die("feed file vanished during startup");
1780       startup_set_input_file(file_f);
1781       SMS(NORMAL, flushfail_retry_periods, "normal startup");
1782     }
1783   }
1784 }
1785
1786 static void statemc_period_poll(void) {
1787   if (!sm_period_counter) return;
1788   sm_period_counter--;
1789   assert(sm_period_counter>=0);
1790
1791   if (sm_period_counter) return;
1792   switch (sms) {
1793   case sm_NORMAL:
1794     statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
1795     break;
1796   case sm_FLUSHFAILED:
1797     spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
1798     break;
1799   default:
1800     abort();
1801   }
1802 }
1803
1804 static void startup_set_input_file(InputFile *f) {
1805   assert(!main_input_file);
1806   main_input_file= f;
1807   inputfile_tailing_start(f);
1808 }
1809
1810 static int inputfile_is_done(InputFile *ipf) {
1811   if (!ipf) return 0;
1812   if (ipf->inprogress) return 0; /* new article in the meantime */
1813   if (ipf->fd >= 0); return 0; /* not had EOF */
1814   return 1;
1815 }
1816
1817 static void notice_processed(InputFile *ipf, const char *what,
1818                              const char *spec) {
1819 #define RCI_NOTHING(x) /* nothing */
1820 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
1821 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, .x)
1822
1823   info("processed %s%s offered=%d(ch%d,nc%d) accepted=%d(ch%d+nc%d)"
1824        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
1825        ,
1826        what,spec,
1827        ipf->counts[art_Unchecked].sent + ipf->counts[art_Unsolicited].sent
1828        , ipf->counts[art_Unchecked].sent, ipf->counts[art_Unsolicited].sent,
1829        ipf->counts[art_Wanted].accepted + ipf->counts[art_Unsolicited].accepted
1830        ,ipf->counts[art_Wanted].accepted,ipf->counts[art_Unsolicited].accepted
1831        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
1832        );
1833 }
1834
1835 static void statemc_check_backlog_done(void) {
1836   InputFile *ipf= backlog_input_file();
1837   if (!inputfile_is_done(ipf)) return;
1838
1839   const char *slash= strrchr(ipf->path, "/");
1840   const char *leaf= slash ? slash+1 : ipf->path;
1841   const char *under= strchr(slash, "_");
1842   const char *rest= under ? under+1 : leaf;
1843   if (!strncmp(rest,"backlog",7)) rest += 7;
1844   notice_processed(ipf,"backlog:",rest);
1845
1846   close_input_file(ipf);
1847   if (unlink(ipf->path)) {
1848     if (errno != ENOENT)
1849       sysdie("could not unlink processed backlog file %s", ipf->path);
1850     warn("backlog file %s vanished while we were reading it"
1851          " so we couldn't remove it (but it's done now, anyway)",
1852          ipf->path);
1853   }
1854   free(ipf);
1855   backlog_input_file= 0;
1856   search_backlog_file();
1857   return;
1858 }
1859
1860 static void statemc_check_flushing_done(void) {
1861   InputFile *ipf= flushing_input_file;
1862   if (!inputfile_is_done(ipf)) return;
1863
1864   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1865
1866   notice_processed(ipf,"feedfile",0);
1867
1868   close_defer();
1869
1870   xunlink(path_flushing, "old flushing file");
1871
1872   close_input_file(flushing_input_file);
1873   free(flushing_input_file);
1874   flushing_input_file= 0;
1875
1876   if (sms==sm_SEPARATED) {
1877     notice("flush complete");
1878     SMS(NORMAL, 0, "flush complete");
1879   } else if (sms==sm_DROPPING) {
1880     SMS(DROPPED, 0, "old flush complete");
1881     search_backlog_file();
1882     notice("feed dropped, but will continue until backlog is finished");
1883   }
1884 }
1885
1886 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
1887                                       void *u) {
1888   assert(!inputfile_is_done(main_input_file));
1889   statemc_check_flushing_done();
1890   statemc_check_backlog_done();
1891   return OOP_CONTINUE;
1892 }
1893
1894 static void queue_check_input_done(void) {
1895   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
1896 }
1897
1898 static void statemc_setstate(StateMachineState newsms, int periods,
1899                              const char *forlog, const char *why) {
1900   sms= newsms;
1901   sm_period_counter= periods;
1902
1903   const char *xtra= "";
1904   switch (sms) {
1905   case sm_FLUSHING: sm_FLUSHFAILED:
1906     if (!main_input_file) xtra= "-ABSENT";
1907     break;
1908   case sm_SEPARATED: case sm_DROPPING:
1909     xtra= flushing_input_file->fd >= 0 ? "-1" : "-2";
1910     break;
1911   default:;
1912   }
1913
1914   if (periods) {
1915     info("%s%s[%d] %s",forlog,xtra,periods,why);
1916   } else {
1917     info("%s%s %s",forlog,xtra,why);
1918   }
1919 }
1920
1921 /*---------- defer and backlog files ----------*/
1922
1923 static void open_defer(void) {
1924   struct stat stab;
1925
1926   if (defer) return;
1927
1928   defer= fopen(path_defer, "a+");
1929   if (!defer) sysfatal("could not open defer file %s", path_defer);
1930
1931   /* truncate away any half-written records */
1932
1933   xfstat_isreg(fileno(defer), &stab, "newly opened defer file");
1934
1935   if (stab.st_size > LONG_MAX)
1936     die("defer file %s size is far too large", path_defer);
1937
1938   if (!stab.st_size)
1939     return;
1940
1941   long orgsize= stab.st_size;
1942   long truncto= stab.st_size;
1943   for (;;) {
1944     if (!truncto) break; /* was only (if anything) one half-truncated record */
1945     if (fseek(defer, truncto-1, SEEK_SET) < 0)
1946       sysdie("seek in defer file %s while truncating partial", path_defer);
1947
1948     r= getc(defer);
1949     if (r==EOF) {
1950       if (ferror(defer))
1951         sysdie("failed read from defer file %s", path_defer);
1952       else
1953         die("defer file %s shrank while we were checking it!", path_defer);
1954     }
1955     if (r=='\n') break;
1956     truncto--;
1957   }
1958
1959   if (stab.st_size != truncto) {
1960     warn("truncating half-record at end of defer file %s -"
1961          " shrinking by %ld bytes from %ld to %ld",
1962          path_defer, orgsize - truncto, orgsize, truncto);
1963
1964     if (fflush(defer))
1965       sysfatal("could not flush defer file %s", path_defer);
1966     if (ftruncate(fileno(defer), truncto))
1967       sysdie("could not truncate defer file %s", path_defer);
1968
1969   } else {
1970     info("continuing existing defer file %s (%ld bytes)",
1971          path_defer, orgsize);
1972   }
1973   if (fseek(defer, truncto, SEEK_SET))
1974     sysdie("could not seek to new end of defer file %s", path_defer);
1975 }
1976
1977 static void close_defer(void) {
1978   if (!defer)
1979     return;
1980
1981   xfstat(fileno(defer), &stab, "defer file");
1982
1983   if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
1984   defer= 0;
1985
1986   char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
1987                            (unsigned long)now.tv_sec,
1988                            (unsigned long)stab.st_ino);
1989   if (link(path_defer, path_backlog))
1990     sysfatal("could not install defer file %s as backlog file %s",
1991            path_defer, backlog);
1992   if (unlink(path_defer))
1993     sysdie("could not unlink old defer link %s to backlog file %s",
1994            path_defer, backlog);
1995
1996   if (until_backlog_nextscan < 0 ||
1997       until_backlog_nextscan > backlog_retry_minperiods + 1)
1998     until_backlog_nextscan= backlog_retry_minperiods + 1;
1999 }
2000
2001 static void poll_backlog_file(void) {
2002   if (until_backlog_nextscan < 0) return;
2003   if (until_backlog_nextscan-- > 0) return;
2004   search_backlog_file();
2005 }
2006
2007 static void search_backlog_file(void) {
2008   /* returns non-0 iff there are any backlog files */
2009
2010   glob_t gl;
2011   int r;
2012   struct stat stab;
2013   const char *oldest_path=0;
2014   time_t oldest_mtime, now;
2015
2016   if (backlog_input_file) return 3;
2017
2018  try_again:
2019
2020   r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2021
2022   switch (r) {
2023   case GLOB_ABORTED:
2024     sysdie("failed to expand backlog pattern %s", globpat_backlog);
2025   case GLOB_NOSPACE:
2026     die("out of memory expanding backlog pattern %s", globpat_backlog);
2027   case 0:
2028     for (i=0; i<gl.gl_pathc; i++) {
2029       const char *path= gl.gl_pathv[i];
2030
2031       if (strchr(path,'#') || strchr(path,'~')) {
2032         debug("backlog file search skipping %s", path);
2033         continue;
2034       }
2035       r= stat(path, &stab);
2036       if (r) {
2037         syswarn("failed to stat backlog file %s", path);
2038         continue;
2039       }
2040       if (!S_ISREG(stab.st_mode)) {
2041         warn("backlog file %s is not a plain file (or link to one)", path);
2042         continue;
2043       }
2044       if (!oldest_path || stab.st_mtime < oldest_mtime) {
2045         oldest_path= path;
2046         oldest_mtime= stab.st_mtime;
2047       }
2048     }
2049   case GLOB_NOMATCH: /* fall through */
2050     break;
2051   default:
2052     sysdie("glob expansion of backlog pattern %s gave unexpected"
2053            " nonzero (error?) return value %d", globpat_backlog, r);
2054   }
2055
2056   globfree(&gl);
2057
2058   if (!oldest_path) {
2059     debug("backlog scan: none");
2060
2061     if (sms==sm_DROPPED) {
2062       notice("feed dropped and our work is complete");
2063       xunlink(path_lock, "lockfile for old feed");
2064       exit(0);
2065     }
2066     until_backlog_nextscan= backlog_spontaneous_rescan_periods;
2067     return 0;
2068   }
2069
2070   now= time();  if (now==-1) sysdie("time(2) failed");
2071   double age= difftime(now, oldest_mtime);
2072   long age_deficiency= (backlog_retry_minperiods * PERIOD_SECONDS) - age;
2073
2074   if (age_deficiency <= 0) {
2075     debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2076           age, age_deficiency, oldest_path);
2077
2078     backlog_input_file= open_input_file(oldest_path);
2079     if (!backlog_input_file) {
2080       warn("backlog file %s vanished as we opened it", backlog_input_file);
2081       goto try_again;
2082     }
2083     inputfile_tailing_start(backlog_input_file);
2084     until_backlog_nextscan= -1;
2085     return 1;
2086   }
2087
2088   until_backlog_nextscan= age_deficiency / PERIOD_SECONDS;
2089
2090   if (backlog_spontaneous_rescan_periods >= 0 &&
2091       until_backlog_nextscan > backlog_spontaneous_rescan_periods)
2092     until_backlog_nextscan= backlog_spontaneous_rescan_periods;
2093
2094   debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2095         age, age_deficiency, until_backlog_nextscan, oldest_path);
2096   return 2;
2097 }
2098
2099 /*========== flushing the feed ==========*/
2100
2101 static pid_t inndcomm_child;
2102
2103 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
2104   assert(inndcomm_child);
2105   int status= xwaitpid(&inndcomm_child, "inndcomm");
2106   loop->cancel_fd(fd);
2107   close(fd);
2108
2109   assert(!flushing_input_file);
2110
2111   if (WIFEXITED(status)) {
2112     switch (WEXITSTATUS(status)) {
2113
2114     case INNDCOMMCHILD_ESTATUS_FAIL:
2115       goto failed;
2116
2117     case INNDCOMMCHILD_ESTATUS_NONESUCH:
2118       warn("feed has been dropped by innd, finishing up");
2119       flushing_input_file= main_input_file;
2120       tailing_queue_readable(flushing_input_file);
2121         /* we probably previously returned EAGAIN from our fake read method
2122          * when in fact we were at EOF, so signal another readable event
2123          * so we actually see the EOF */
2124
2125       main_input_file= 0;
2126
2127       if (flushing_input_file) {
2128         SMS(DROPPING, 0, "feed dropped by innd, but must finish last flush");
2129       } else {
2130         close_defer();
2131         SMS(DROPPED, 0, "feed dropped by innd");
2132         search_backlog_file();
2133       }
2134       return OOP_CONTINUE;
2135
2136     case 0:
2137       /* as above */
2138       flushing_input_file= main_input_file;
2139       tailing_queue_readable(flushing_input_file);
2140
2141       main_input_file= open_input_file(feedfile);
2142       if (!main_input_file)
2143         die("flush succeeded but feedfile %s does not exist!", feedfile);
2144
2145       if (flushing_input_file) {
2146         SMS(SEPARATED, spontaneous_flush_periods, "recovery flush complete");
2147       } else {
2148         close_defer();
2149         SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2150       }
2151       return OOP_CONTINUE;
2152
2153     default:
2154       goto unexpected_exitstatus;
2155
2156     }
2157   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
2158     warn("flush timed out trying to talk to innd");
2159     goto failed;
2160   } else {
2161   unexpected_exitstatus:
2162     report_child_status("inndcomm child", status);
2163   }
2164
2165  failed:
2166   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
2167 }
2168
2169 static void inndcommfail(const char *what) {
2170   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
2171   exit(INNDCOMMCHILD_ESTATUS_FAIL);
2172 }
2173
2174 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
2175   int pipefds[2];
2176
2177   notice("flushing %s",why);
2178
2179   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
2180   assert(!inndcomm_child);
2181
2182   if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
2183
2184   inndcomm_child= xfork();
2185
2186   if (!inndcomm_child) {
2187     static char flushargv[2]= { sitename, 0 };
2188     char *reply;
2189
2190     close(pipefds[0]);
2191
2192     alarm(inndcomm_flush_timeout);
2193     r= ICCopen();                         if (r)   inndcommfail("connect");
2194     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
2195     if (!r) exit(0); /* yay! */
2196
2197     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
2198     syswarn("innd ctlinnd flush failed: innd said %s", reply);
2199     exit(INNDCOMMCHILD_ESTATUS_FAIL);
2200   }
2201
2202   close(pipefds[1]);
2203   int sentinel_fd= pipefds[0];
2204   on_fd_read_except(sentinel_fd, inndcomm_event);
2205
2206   SMS(FLUSHING, 0, why);
2207 }
2208
2209 /*========== main program ==========*/
2210
2211 static void postfork_inputfile(InputFile *ipf) {
2212   if (!ipf) return;
2213   assert(ipf->fd >= 0);
2214   close(ipf->fd);
2215   ipf->fd= -1;
2216 }
2217
2218 static void postfork_stdio(FILE *f) {
2219   /* we have no stdio streams that are buffered long-term */
2220   if (f) fclose(f);
2221 }
2222
2223 static void postfork(const char *what) {
2224   if (signal(SIGPIPE, SIG_DFL) == SIG_ERR)
2225     sysdie("%s child: failed to reset SIGPIPE");
2226
2227   postfork_inputfile(main_input_file);
2228   postfork_inputfile(flushing_input_file);
2229
2230   Conn *conn;
2231   for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
2232     close(conn->fd);
2233
2234   postfork_stdio(defer);
2235 }
2236
2237 #define EVERY(what, interval, body)                                          \
2238   static const struct timeval what##_timeout = { 5, 0 };                     \
2239   static void what##_schedule(void);                                         \
2240   static void *what##_timedout(oop_source *lp, struct timeval tv, void *u) { \
2241     { body }                                                                 \
2242     what##_schedule();                                                       \
2243   }                                                                          \
2244   static void what##_schedule(void) {                                        \
2245     loop->on_time(loop, what##_timeout, what##_timedout, 0);                 \
2246   }
2247
2248 EVERY(filepoll, {5,0}, {
2249   if (main_input_file && main_input_file->readable_callback)
2250     filemon_callback(main_input_file);
2251 });
2252
2253 #define DEBUGF_IPF(wh) " " #wh "=%p/%s:ip=%ld,off=%ld,fd=%d%s"  \
2254 #define DEBUG_IPF(sh)                                           \
2255   wh##_input_file, debug_ipf_path(wh##_input_file),             \
2256   wh##_input_file->inprogress, (long)wh##_input_file->offset,   \
2257   wh##_input_file->fd, wh##_input_file->rd ? "+" : ""
2258 static const char *debug_ipf_path(InputFile *ipf) {
2259   char *slash= strrchr(ipf->path,'/');
2260   return slash ? slash+1 : ipf->path;
2261 }
2262
2263 EVERY(period, {PERIOD_SECONDS,0}, {
2264   debug("PERIOD"
2265         " sms=%s[%d] conns=%d queue=%d until_connect=%d"
2266         " input_files" DEBUGF_IPF(main) DEBUGF_IPF(old) DEBUGF_FMT(flushing)
2267         " children connecting=%ld inndcomm_child"
2268         ,
2269         sms_names[sms], sm_period_counter,
2270         queue.count, conns.count, until_connect,
2271         DEBUG_IPF(main), DEBUG_IPF(flushing), DEBUG_IPF(flushing),
2272         (long)connecting_child, (long)inndcomm_child
2273         );
2274
2275   if (until_connect) until_connect--;
2276
2277   poll_backlog_file();
2278   if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
2279   statemc_period_poll();
2280   check_master_queue();
2281 });
2282
2283
2284 /*========== option parsing ==========*/
2285
2286 enum OptFlags {
2287   of_seconds= 001000u;
2288   of_boolean= 002000u;
2289 };
2290
2291 typedef struct Option Option;
2292 typedef void OptionParser(const Option*, const char *val);
2293
2294 struct Option {
2295   int short;
2296   const char *long;
2297   void *store;
2298   OptionParser *fn;
2299   int noarg;
2300 };
2301
2302 void op_integer(const Option *o, const char *val) {
2303   char *ep;
2304   errno= 0;
2305   unsigned long ul= strtoul(val,&ep,10);
2306   if (*ep || ep==val || errno || ul>INT_MAX)
2307     badusage("bad integer value for %s",o->long);
2308   int *store= o->store;
2309   *store= ul;
2310 }
2311
2312 void op_double(const Option *o, const char *val) {
2313   int *store= o->store;
2314   char *ep;
2315   errno= 0;
2316   *store= strtod(val, &ep);
2317   if (*ep || ep==val || errno)
2318     badusage("bad floating point value for %s",o->long);
2319 }
2320
2321 void op_string(const Option *o, const char *val) {
2322   char **store= o->store;
2323   free(*store);
2324   *store= val;
2325 }
2326
2327 void op_seconds(const Option *o, const char *val) {
2328   int *store= o->store;
2329   char *ep;
2330
2331   double v= strtod(val,&ep);
2332   if (ep==val) badusage("bad time/duration value for %s",o->long);
2333
2334   if (!*ep || !strcmp(ep,"s")) unit= 1;
2335   else if (!strcmp(ep,"m")) unit= 60;
2336   else if (!strcmp(ep,"h")) unit= 3600;
2337   else if (!strcmp(ep,"d")) unit= 86400;
2338   else badusage("bad units %s for time/duration value for %s",ep,o->long);
2339
2340   v *= unit;
2341   v= ceil(v);
2342   if (v > INT_MAX) badusage("time/duration value for %s out of range",o->long);
2343   *store= v;
2344 }
2345
2346 void op_periods_rndup(const Option *o, const char *val) {
2347   int *store= o->store;
2348   op_seconds(o,val);
2349   *store += PERIOD_SECONDS-1;
2350   *store /= PERIOD_SECONDS;
2351 }
2352
2353 void op_periods_booltrue(const Option *o, const char *val) {
2354   int *store= o->store;
2355   *store= 1;
2356 }
2357 void op_periods_boolfalse(const Option *o, const char *val) {
2358   int *store= o->store;
2359   *store= 0;
2360 }
2361
2362 static const Option options[]= {
2363 {'f',"feedfile",              &feedfile,                 op_string           },
2364 {'q',"quiet-multiple",        &quiet_multiple,           op_booltrue,  1     },
2365
2366 { 0, "max-connections",       &max_connections           op_integer          },
2367 { 0, "max-queue-per-conn",    &max_queue_per_conn        op_integer          },
2368
2369
2370 { 0, "streaming",             &try_stream,               op_booltrue,  1     },
2371 { 0, "no-streaming",          &try_stream,               op_boolfalse, 1     },
2372 {'P',"port",                  &port                      op_integer          },
2373 { 0, "inndconf",              &inndconffile,             op_string           },
2374 {'d',"daemon",                &become_daemon,            op_booltrue,  1     },
2375 { 0, "no-daemon",             &become_daemon,            op_boolfalse, 1     },
2376
2377 { 0, "no-check-proportion",   &nocheck_thresh_pct,       op_double           },
2378 { 0, "no-check-filter",       &nocheck_decay_articles,   op_double           },
2379
2380 { 0, "reconnect-interval",    &reconnect_delay_periods,  op_periods_rndup    },
2381 { 0, "flush-retry-interval",  &flushfail_retry_periods,  op_periods_rndup    },
2382 { 0, "connection-timeout",    &connection_timeout,       op_seconds          },
2383 { 0, "inndcomm-timeout",      &inndcomm_flush_timeout,   op_seconds          },
2384 };
2385
2386 int main(int argc, char **argv) {
2387   const char *arg;
2388
2389   for (;;) {
2390     arg= *++argv;
2391     if (!arg) break;
2392     if (*arg != '-') break;
2393     if (!strcmp(arg,"--")) { arg= *++argv; break; }
2394     int a;
2395     while ((a= *++arg)) {
2396       const Option *o;
2397       if (a=='-') {
2398         arg++;
2399         char *equals= strchr(arg,'=');
2400         int len= equals ? (equals - arg) : strlen(arg);
2401         for (o=options; o->long; o++)
2402           if (strlen(o->long) == len && !memcmp(o->long,arg,len))
2403             goto found_long;
2404         badusage("unknown long option --%s",arg);
2405       found_long:
2406         if (o->noarg) {
2407           if (equals) badusage("option --%s does not take a value",o->long);
2408           arg= 0;
2409         } else if (equals) {
2410           arg= equals+1;
2411         } else {
2412           arg= *++argv;
2413           if (!arg) badusage("option --%s needs a value",o->long);
2414         }
2415         o->fn(o, arg);
2416         break; /* eaten the whole argument now */
2417       }
2418       for (o=options; o->long; o++)
2419         if (a == o->short)
2420           goto found_short;
2421       badusage("unknown short option -%c",a);
2422     found_short:
2423       if (o->noarg) {
2424         o->fn(o,0);
2425       } else {
2426         if (!*++arg) {
2427           arg= *++argv;
2428           if (!arg) badusage("option -%c needs a value",o->short);
2429         }
2430         o->fn(o,arg);
2431         break; /* eaten the whole argument now */
2432       }
2433     }
2434   }
2435
2436   if (!arg) badusage("need site name argument");
2437   sitename= arg;
2438
2439   if ((arg= *++argv))
2440     remote_host= arg;
2441
2442   if (*++argv) badusage("too many non-option arguments");
2443
2444   if (nocheck_thresh_pct < 0 || nocheck_thresh_pct > 100)
2445     badusage("nocheck threshold percentage must be between 0..100");
2446   nocheck_thresh= nocheck_thresh_pct * 0.01;
2447
2448   if (nocheck_decay_articles < 0.1)
2449     badusage("nocheck decay articles must be at least 0.1");
2450   nocheck_decay= 1 - 1/nocheck_decay_articles;
2451
2452   if (!pathoutgoing)
2453     pathoutgoing= innconf->pathoutgoing;
2454   innconf_read(inndconffile);
2455
2456   if (!feedfile)
2457     feedfile= xasprintf("%s/%s",pathoutgoing,sitename);
2458   else if (!feedfile[0])
2459     badusage("feed filename must be nonempty");
2460   else if (feedfile[strlen(feedfile)-1]=='/')
2461     feedfile= xasprintf("%s%s",feedfile,sitename);
2462
2463   const char *feedfile_forbidden= "?*[~#";
2464   int c;
2465   while ((c= *feedfile_forbidden++))
2466     if (strchr(feedfile, c))
2467       badusage("feed filename may not contain metacharacter %c",c);
2468
2469   loop= oop_sys_new();
2470   if (!loop) sysdie("could not create liboop event loop");
2471
2472   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
2473     sysdie("could not ignore SIGPIPE");
2474
2475   if (become_daemon) {
2476     for (i=3; i<255; i++)
2477       /* do this now before we open syslog, etc. */
2478       close(i);
2479     openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
2480
2481     int null= open("/dev/null",O_RDWR);
2482     if (null<0) sysdie("failed to open /dev/null");
2483     dup2(null,0);
2484     dup2(null,1);
2485     dup2(null,2);
2486     close(null);
2487
2488     pid_t child1= xfork("daemonise first fork");
2489     if (child1) _exit(0);
2490
2491     pid_t sid= setsid();
2492     if (sid != child1) sysdie("setsid failed");
2493
2494     pid_t child2= xfork("daemonise second fork");
2495     if (child2) _exit(0);
2496   }
2497
2498   notice("starting");
2499
2500   if (!filemon_init()) {
2501     warn("no file monitoring available, polling");
2502     filepoll_schedule();
2503   }
2504
2505   period_schedule();
2506
2507   statemc_init();
2508
2509   loop->execute.
2510 }