chiark / gitweb /
rename control_ stuff to cli
authorIan Jackson <ian@liberator.relativity.greenend.org.uk>
Mon, 3 May 2010 12:45:15 +0000 (13:45 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Mon, 3 May 2010 12:45:15 +0000 (13:45 +0100)
backends/innduct.c
doc/man/innduct.8

index a767933..c5a49c9 100644 (file)
@@ -217,7 +217,7 @@ perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.
 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
 
 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
-#define MAX_CONTROL_COMMAND 1000
+#define MAX_CLI_COMMAND 1000
 
 #define VA                va_list al;  va_start(al,fmt)
 #define PRINTF(f,a)       __attribute__((__format__(printf,f,a)))
@@ -293,7 +293,7 @@ typedef struct InputFile InputFile;
 typedef struct XmitDetails XmitDetails;
 typedef struct Filemon_Perfile Filemon_Perfile;
 typedef enum StateMachineState StateMachineState;
-typedef struct ControlCommand ControlCommand;
+typedef struct CliCommand CliCommand;
 
 DEFLIST(Conn);
 DEFLIST(Article);
@@ -356,7 +356,7 @@ static oop_rd_call peer_rd_err, peer_rd_ok;
 /* when changing defaults, remember to update the manpage */
 
 static const char *sitename, *remote_host;
-static const char *feedfile, *path_control;
+static const char *feedfile, *path_cli;
 static int quiet_multiple=0;
 static int become_daemon=1, try_filemon=1;
 static int try_stream=1;
@@ -783,13 +783,13 @@ static int isewouldblock(int errnoval) {
   return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
 }
 
-/*========== command and control connections ==========*/
+/*========== command and control (CLI) connections ==========*/
 
-static int control_master;
+static int cli_master;
 
-typedef struct ControlConn ControlConn;
-struct ControlConn {
-  void (*destroy)(ControlConn*);
+typedef struct CliConn CliConn;
+struct CliConn {
+  void (*destroy)(CliConn*);
   int fd;
   oop_read *rd;
   FILE *out;
@@ -800,46 +800,46 @@ struct ControlConn {
   socklen_t salen;
 };
 
-static const oop_rd_style control_rd_style= {
+static const oop_rd_style cli_rd_style= {
   OOP_RD_DELIM_STRIP, '\n',
   OOP_RD_NUL_FORBID,
   OOP_RD_SHORTREC_FORBID
 };
 
-static void control_destroy(ControlConn *cc) {
+static void cli_destroy(CliConn *cc) {
   cc->destroy(cc);
 }
 
-static void control_checkouterr(ControlConn *cc /* may destroy*/) {
+static void cli_checkouterr(CliConn *cc /* may destroy*/) {
   if (ferror(cc->out) | fflush(cc->out)) {
     info("CTRL%d write error %s", cc->fd, strerror(errno));
-    control_destroy(cc);
+    cli_destroy(cc);
   }
 }
 
-static void control_prompt(ControlConn *cc /* may destroy*/) {
+static void cli_prompt(CliConn *cc /* may destroy*/) {
   fprintf(cc->out, "%s| ", sitename);
-  control_checkouterr(cc);
+  cli_checkouterr(cc);
 }
 
-struct ControlCommand {
+struct CliCommand {
   const char *cmd;
-  void (*f)(ControlConn *cc, const ControlCommand *ccmd,
+  void (*f)(CliConn *cc, const CliCommand *ccmd,
            const char *arg, size_t argsz);
   void *xdata;
   int xval;
 };
 
-static const ControlCommand control_commands[];
+static const CliCommand cli_commands[];
 
-#define CCMD(wh)                                                       \
-  static void ccmd_##wh(ControlConn *cc, const ControlCommand *c,      \
+#define CCMD(wh)                                               \
+  static void ccmd_##wh(CliConn *cc, const CliCommand *c,      \
                        const char *arg, size_t argsz)
 
 CCMD(help) {
   fputs("commands:\n", cc->out);
-  const ControlCommand *ccmd;
-  for (ccmd=control_commands; ccmd->cmd; ccmd++)
+  const CliCommand *ccmd;
+  for (ccmd=cli_commands; ccmd->cmd; ccmd++)
     fprintf(cc->out, " %s\n", ccmd->cmd);
   fputs("NB: permissible arguments are not shown above."
        "  Not all commands listed are safe.  See innduct(8).\n", cc->out);
@@ -865,7 +865,7 @@ CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
 CCMD(setint) { *(int*)c->xdata= c->xval; }
 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
 
-static const ControlCommand control_commands[]= {
+static const CliCommand cli_commands[]= {
   { "h",             ccmd_help      },
   { "flush",         ccmd_flush     },
   { "stop",          ccmd_stop      },
@@ -886,10 +886,10 @@ POKES("prod ", ccmd_setint_period)
   { 0 }
 };
 
-static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
-                          const char *errmsg, int errnoval,
-                          const char *data, size_t recsz, void *cc_v) {
-  ControlConn *cc= cc_v;
+static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
+                      const char *errmsg, int errnoval,
+                      const char *data, size_t recsz, void *cc_v) {
+  CliConn *cc= cc_v;
 
   if (!data) {
     info("CTRL%d closed", cc->fd);
@@ -899,8 +899,8 @@ static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
 
   if (recsz == 0) goto prompt;
 
-  const ControlCommand *ccmd;
-  for (ccmd=control_commands; ccmd->cmd; ccmd++) {
+  const CliCommand *ccmd;
+  for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
     int l= strlen(ccmd->cmd);
     if (recsz < l) continue;
     if (recsz > l && data[l] != ' ') continue;
@@ -914,36 +914,36 @@ static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
   fputs("unknown command; h for help\n", cc->out);
 
  prompt:
-  control_prompt(cc);
+  cli_prompt(cc);
   return OOP_CONTINUE;
 }
 
-static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
-                           const char *errmsg, int errnoval,
-                           const char *data, size_t recsz, void *cc_v) {
-  ControlConn *cc= cc_v;
+static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
+                       const char *errmsg, int errnoval,
+                       const char *data, size_t recsz, void *cc_v) {
+  CliConn *cc= cc_v;
   
   info("CTRL%d read error %s", cc->fd, errmsg);
   cc->destroy(cc);
   return OOP_CONTINUE;
 }
 
-static int control_conn_startup(ControlConn *cc /* may destroy*/,
+static int cli_conn_startup(CliConn *cc /* may destroy*/,
                                const char *how) {
   cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
-  if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
+  if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
 
-  int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
-                     control_rd_ok, cc,
-                     control_rd_err, cc);
-  if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
+  int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
+                     cli_rd_ok, cc,
+                     cli_rd_err, cc);
+  if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
 
   info("CTRL%d %s ready", cc->fd, how);
-  control_prompt(cc);
+  cli_prompt(cc);
   return 0;
 }
 
-static void control_stdio_destroy(ControlConn *cc) {
+static void cli_stdio_destroy(CliConn *cc) {
   if (cc->rd) {
     oop_rd_cancel(cc->rd);
     errno= oop_rd_delete_tidy(cc->rd);
@@ -952,17 +952,17 @@ static void control_stdio_destroy(ControlConn *cc) {
   free(cc);
 }
 
-static void control_stdio(void) {
-  NEW_DECL(ControlConn *,cc);
-  cc->destroy= control_stdio_destroy;
+static void cli_stdio(void) {
+  NEW_DECL(CliConn *,cc);
+  cc->destroy= cli_stdio_destroy;
 
   cc->fd= 0;
   cc->out= stdout;
-  int r= control_conn_startup(cc,"stdio");
+  int r= cli_conn_startup(cc,"stdio");
   if (r) cc->destroy(cc);
 }
 
-static void control_accepted_destroy(ControlConn *cc) {
+static void cli_accepted_destroy(CliConn *cc) {
   if (cc->rd) {
     oop_rd_cancel(cc->rd);
     oop_rd_delete_kill(cc->rd);
@@ -972,19 +972,19 @@ static void control_accepted_destroy(ControlConn *cc) {
   free(cc);
 }
 
-static void *control_master_readable(oop_source *lp, int master,
-                                    oop_event ev, void *u) {
-  NEW_DECL(ControlConn *,cc);
-  cc->destroy= control_accepted_destroy;
+static void *cli_master_readable(oop_source *lp, int master,
+                                oop_event ev, void *u) {
+  NEW_DECL(CliConn *,cc);
+  cc->destroy= cli_accepted_destroy;
 
   cc->salen= sizeof(cc->sa);
   cc->fd= accept(master, &cc->sa.sa, &cc->salen);
-  if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
+  if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
 
   cc->out= fdopen(cc->fd, "w");
-  if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
+  if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
 
-  int r= control_conn_startup(cc, "accepted");
+  int r= cli_conn_startup(cc, "accepted");
   if (r) goto x;
 
   return OOP_CONTINUE;
@@ -994,12 +994,12 @@ static void *control_master_readable(oop_source *lp, int master,
   return OOP_CONTINUE;
 }
 
-#define NOCONTROL(...) do{                                             \
-    syswarn("no control socket, because failed to " __VA_ARGS__);      \
-    goto nocontrol;                                                    \
+#define NOCLI(...) do{                                         \
+    syswarn("no cli listener, because failed to " __VA_ARGS__);        \
+    goto nocli;                                                        \
   }while(0)
 
-static void control_init(void) {
+static void cli_init(void) {
   union {
     struct sockaddr sa;
     struct sockaddr_un un;
@@ -1008,37 +1008,36 @@ static void control_init(void) {
   memset(&sa,0,sizeof(sa));
   int maxlen= sizeof(sa.un.sun_path);
 
-  int pathlen= strlen(path_control);
+  int pathlen= strlen(path_cli);
   if (pathlen > maxlen)
-    NOCONTROL("control socket path %s too long (%d>%d)",
-             path_control, pathlen, maxlen);
+    NOCLI("cli socket path %s too long (%d>%d)", path_cli, pathlen, maxlen);
 
-  int r= unlink(path_control);
+  int r= unlink(path_cli);
   if (r && errno!=ENOENT)
-    NOCONTROL("remove old control socket %s", path_control);
+    NOCLI("remove old cli socket %s", path_cli);
 
-  control_master= socket(PF_UNIX, SOCK_STREAM, 0);
-  if (control_master<0) NOCONTROL("create new control socket");
+  cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
+  if (cli_master<0) NOCLI("create new cli master socket");
 
   int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
   sa.un.sun_family= AF_UNIX;
-  memcpy(sa.un.sun_path, path_control, pathlen);
+  memcpy(sa.un.sun_path, path_cli, pathlen);
 
-  r= bind(control_master, &sa.sa, sl);
-  if (r) NOCONTROL("bind to control socket path %s", sa.un.sun_path);
+  r= bind(cli_master, &sa.sa, sl);
+  if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
 
-  r= listen(control_master, 5);
-  if (r) NOCONTROL("listen");
+  r= listen(cli_master, 5);
+  if (r) NOCLI("listen to cli master socket");
 
-  xsetnonblock(control_master, 1);
+  xsetnonblock(cli_master, 1);
 
-  loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
-  info("control socket ok, listening on %s", path_control);
+  loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
+  info("cli ready, listening on %s", path_cli);
 
   return;
 
- nocontrol:
-  xclose_perhaps(&control_master, "control master",0);
+ nocli:
+  xclose_perhaps(&cli_master, "cli master",0);
   return;
 }
 
@@ -2899,11 +2898,11 @@ static void search_backlog_file(void) {
       preterminate();
       notice("feed dropped and our work is complete");
 
-      int r= unlink(path_control);
+      int r= unlink(path_cli);
       if (r && errno!=ENOENT)
-       syswarn("failed to remove control symlink for old feed");
+       syswarn("failed to unlink cli socket for old feed");
 
-      xunlink(path_lock,    "lockfile for old feed");
+      xunlink(path_lock, "lockfile for old feed");
       exit(4);
     }
     until_backlog_nextscan= backlog_spontrescan_periods;
@@ -3255,7 +3254,7 @@ static void period(void) {
 
 /*========== dumping state ==========*/
 
-static void dump_article_list(FILE *f, const ControlCommand *c,
+static void dump_article_list(FILE *f, const CliCommand *c,
                              const ArticleList *al) {
   fprintf(f, " count=%d\n", al->count);
   if (!c->xval) return;
@@ -3272,7 +3271,7 @@ static void dump_article_list(FILE *f, const ControlCommand *c,
   }
 }
   
-static void dump_input_file(FILE *f, const ControlCommand *c,
+static void dump_input_file(FILE *f, const CliCommand *c,
                            InputFile *ipf, const char *wh) {
   char *dipf= debug_report_ipf(ipf);
   fprintf(f,"input %s %s", wh, dipf);
@@ -3323,7 +3322,7 @@ CCMD(dump) {
   fprintf(f,"special");
   DUMPV("%ld", (long),connecting_child);
   DUMPV("%d", , connecting_fdpass_sock);
-  DUMPV("%d", , control_master);
+  DUMPV("%d", , cli_master);
   fprintf(f,"\n");
 
   fprintf(f,"filemon ");
@@ -3367,7 +3366,7 @@ CCMD(dump) {
 
   fprintf(f,"paths");
   DUMPV("%s", , feedfile);
-  DUMPV("%s", , path_control);
+  DUMPV("%s", , path_cli);
   DUMPV("%s", , path_lock);
   DUMPV("%s", , path_flushing);
   DUMPV("%s", , path_defer);
@@ -3554,7 +3553,7 @@ static const Option innduct_options[]= {
 {0,"no-filemon",         0,       &try_filemon,              op_setint, 0   },
 {'C',"inndconf",         "F",     &inndconffile,             op_string      },
 {'P',"port",             "PORT",  &port,                     op_integer     },
-{0,"cli",                0,       &path_control,             op_string      },
+{0,"cli",                0,       &path_cli,                 op_string      },
 {0,"help",               0,       0,                         help           },
 
 {0,"max-connections",    "N",     &max_connections,          op_integer     },
@@ -3657,8 +3656,8 @@ int main(int argc, char **argv) {
   if (!feedfile) feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
   else assemble_path(&feedfile, "", "feed filename");
 
-  if (path_control) path_control= xasprintf("%s_cli", feedfile);
-  else assemble_path(&path_control, "%s_cli", "control socket path");
+  if (path_cli) path_cli= xasprintf("%s_cli", feedfile);
+  else assemble_path(&path_cli, "%s_cli", "cli socket path");
 
   if (max_queue_per_ipf<0)
     max_queue_per_ipf= max_queue_per_conn * 2;
@@ -3718,12 +3717,12 @@ int main(int argc, char **argv) {
 
   int val= 1;
   r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
-//  r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
+  r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
 
   if (!become_daemon)
-    control_stdio();
+    cli_stdio();
 
-  control_init();
+  cli_init();
 
   int filemon_ok= 0;
   if (!try_filemon) {
index 055d083..2032e38 100644 (file)
@@ -88,7 +88,8 @@ be logged and a nonzero exit.
 .TP
 .BR \-\-no-daemon
 Do not daemonise.  innduct runs in the foreground and all messages
-(including all debug messages) are written to stderr.
+(including all debug messages) are written to stderr.  A control
+command line is also available on stdin/stdout.
 .TP
 .BI \-\-no-streaming
 Do not try to use the streaming extensions to NNTP (for use eg if the
@@ -107,7 +108,7 @@ instead of the default
 .BR inn.conf .
 .TP
 .BR \-\-cli= \fIDIR\fR / |\fIPATH\fR
-Bind the control command line socket to
+Listen for control command line connections on
 .IB DIR / site _cli
 (if the value ends with a
 .BR /)