Rename nscd_invalidate option to reconnect_invalidate

This also renames the internal nscd module to invalidator for both nslcd
and pynslcd. The new invalidator module is now no longer nscd-specific.

7 files changed, 65 insertions, 62 deletions

diff --git a/nslcd/Makefile.am b/nslcd/Makefile.am
index 60560f8..4346f21 100644
--- a/nslcd/Makefile.am
+++ b/nslcd/Makefile.am
@@ -30,7 +30,7 @@ nslcd_SOURCES = nslcd.c ../nslcd.h ../common/nslcd-prot.h \
                 myldap.c myldap.h \
                 cfg.c cfg.h \
                 attmap.c attmap.h \
-                nsswitch.c nscd.c \
+                nsswitch.c invalidator.c \
                 config.c alias.c ether.c group.c host.c netgroup.c network.c \
                 passwd.c protocol.c rpc.c service.c shadow.c pam.c usermod.c
 nslcd_LDADD = ../common/libtio.a ../common/libdict.a \
diff --git a/nslcd/cfg.c b/nslcd/cfg.c
index 381ddec..ec1237c 100644
--- a/nslcd/cfg.c
+++ b/nslcd/cfg.c
@@ -934,7 +934,7 @@ static void handle_pam_password_prohibit_message(
   cfg->pam_password_prohibit_message = value;
 }
 
-static void handle_nscd_invalidate(
+static void handle_reconnect_invalidate(
                 const char *filename, int lnr,
                 const char *keyword, char *line, struct ldap_config *cfg)
 {
@@ -963,7 +963,7 @@ static void handle_nscd_invalidate(
         log_log(LOG_ERR, "%s:%d: unknown map: '%s'", filename, lnr, name);
         exit(EXIT_FAILURE);
       }
-      cfg->nscd_invalidate[map] = 1;
+      cfg->reconnect_invalidate[map] = 1;
     }
   }
 }
@@ -1100,7 +1100,7 @@ static void cfg_defaults(struct ldap_config *cfg)
     cfg->pam_authz_searches[i] = NULL;
   cfg->pam_password_prohibit_message = NULL;
   for (i = 0; i < LM_NONE; i++)
-    cfg->nscd_invalidate[i] = 0;
+    cfg->reconnect_invalidate[i] = 0;
 }
 
 static void cfg_read(const char *filename, struct ldap_config *cfg)
@@ -1432,9 +1432,9 @@ static void cfg_read(const char *filename, struct ldap_config *cfg)
     {
       handle_pam_password_prohibit_message(filename, lnr, keyword, line, cfg);
     }
-    else if (strcasecmp(keyword, "nscd_invalidate") == 0)
+    else if (strcasecmp(keyword, "reconnect_invalidate") == 0)
     {
-      handle_nscd_invalidate(filename, lnr, keyword, line, cfg);
+      handle_reconnect_invalidate(filename, lnr, keyword, line, cfg);
     }
 #ifdef ENABLE_CONFIGFILE_CHECKING
     /* fallthrough */
@@ -1689,14 +1689,14 @@ static void cfg_dump(void)
   /* build a comma-separated list */
   buffer[0] = '\0';
   for (i = 0; i < LM_NONE ; i++)
-    if (nslcd_cfg->nscd_invalidate[i])
+    if (nslcd_cfg->reconnect_invalidate[i])
     {
       if (buffer[0] != '\0')
         strncat(buffer, ",", sizeof(buffer) - 1 - strlen(buffer));
       strncat(buffer, print_map(i), sizeof(buffer) - 1 - strlen(buffer));
     }
   if (buffer[0] != '\0')
-    log_log(LOG_DEBUG, "CFG: nscd_invalidate %s", buffer);
+    log_log(LOG_DEBUG, "CFG: reconnect_invalidate %s", buffer);
 }
 
 void cfg_init(const char *fname)
diff --git a/nslcd/cfg.h b/nslcd/cfg.h
index 4ec31ff..65b2058 100644
--- a/nslcd/cfg.h
+++ b/nslcd/cfg.h
@@ -126,7 +126,7 @@ struct ldap_config {
   int ignorecase; /* whether or not case should be ignored in lookups */
   char *pam_authz_searches[NSS_LDAP_CONFIG_MAX_AUTHZ_SEARCHES]; /* the searches that should be performed to do autorisation checks */
   char *pam_password_prohibit_message;   /* whether password changing should be denied and user prompted with this message */
-  char nscd_invalidate[LM_NONE];  /* set to 1 if the corresponding map should be invalidated */
+  char reconnect_invalidate[LM_NONE];  /* set to 1 if the corresponding map should be invalidated */
 };
 
 /* this is a pointer to the global configuration, it should be available
diff --git a/nslcd/common.h b/nslcd/common.h
index a6c2c4d..fce92f6 100644
--- a/nslcd/common.h
+++ b/nslcd/common.h
@@ -141,11 +141,11 @@ void nsswitch_check_reload(void);
 int nsswitch_shadow_uses_ldap(void);
 
 /* start a child process that holds onto the original privileges with the
-   sole purpose of running nscd -i commands */
-int nscd_start_invalidator(void);
+   purpose of running external cache invalidation commands */
+int invalidator_start(void);
 
-/* signal nscd to invalidate the selected map */
-void nscd_invalidate(enum ldap_map_selector map);
+/* signal invalidator to invalidate the selected external cache */
+void invalidator_do(enum ldap_map_selector map);
 
 /* fallback definition of HOST_NAME_MAX */
 #ifndef HOST_NAME_MAX
diff --git a/nslcd/nscd.c b/nslcd/invalidator.c
index 14a976c..03584eb 100644
--- a/nslcd/nscd.c
+++ b/nslcd/invalidator.c
@@ -1,5 +1,5 @@
 /*
-   nscd.c - functions for invalidating the nscd cache
+   invalidator.c - functions for invalidating external caches
 
    Copyright (C) 2013 Arthur de Jong
 
@@ -36,7 +36,7 @@
 #include "log.h"
 
 /* the write end of a pipe that is used to signal the child process
-   to call nscd to invalidate the cache */
+   to invalidate the cache */
 static int signalfd = -1;
 
 /* we have our own implementation because nscd could use different names */
@@ -61,16 +61,33 @@ static const char *map2name(enum ldap_map_selector map)
   }
 }
 
-/* invalidate the specified database in nscd */
+/* invalidate the specified database */
 static void exec_invalidate(const char *db)
 {
   pid_t cpid;
   int i, status;
   char *argv[4];
+  char cmdline[80];
 #ifdef HAVE_EXECVPE
   char *newenviron[] = { NULL };
 #endif
-  log_log(LOG_DEBUG, "nscd_invalidator: nscd -i %s", db);
+  /* build command line */
+  if (strcmp(db, "nfsidmap") == 0)
+  {
+    argv[0] = "nfsidmap";
+    argv[1] = "-c";
+    argv[2] = NULL;
+  }
+  else
+  {
+    argv[0] = "nscd";
+    argv[1] = "-i";
+    argv[2] = (char *)db;
+    argv[3] = NULL;
+  }
+  mysnprintf(cmdline, 80, "%s %s%s%s", argv[0], argv[1],
+             argv[2] != NULL ? " " : "", argv[2] != NULL ? argv[2] : "");
+  log_log(LOG_DEBUG, "invalidator: %s", cmdline);
   /* do fork/exec */
   switch (cpid=fork())
   {
@@ -83,20 +100,6 @@ static void exec_invalidate(const char *db)
         i = 32;
       for (; i >= 0; i--)
         close(i);
-      /* build command line */
-      if (strcmp(db, "nfsidmap") == 0)
-      {
-        argv[0] = "nfsidmap";
-        argv[1] = "-c";
-        argv[2] = NULL;
-      }
-      else
-      {
-        argv[0] = "nscd";
-        argv[1] = "-i";
-        argv[2] = (char *)db;
-        argv[3] = NULL;
-      }
       /* execute command */
 #ifdef HAVE_EXECVPE
       execvpe(argv[0], argv, newenviron);
@@ -108,7 +111,7 @@ static void exec_invalidate(const char *db)
       _exit(EXIT_FAILURE);
       break;
     case -1: /* we are the parent, but have an error */
-      log_log(LOG_ERR, "nscd_invalidator: fork() failed: %s", strerror(errno));
+      log_log(LOG_ERR, "invalidator: fork() failed: %s", strerror(errno));
       break;
     default: /* we are the parent */
       /* wait for child exit */
@@ -119,37 +122,37 @@ static void exec_invalidate(const char *db)
       }
       while ((i < 0) && (errno == EINTR));
       if (i < 0)
-        log_log(LOG_ERR, "nscd_invalidator: waitpid(%d) failed: %s", (int)cpid, strerror(errno));
+        log_log(LOG_ERR, "invalidator: waitpid(%d) failed: %s", (int)cpid, strerror(errno));
       else if (WIFEXITED(status))
       {
         i = WEXITSTATUS(status);
         if (i == 0)
-          log_log(LOG_DEBUG, "nscd_invalidator: nscd -i %s (pid %d) success",
-                  db, (int)cpid);
+          log_log(LOG_DEBUG, "invalidator: %s (pid %d) success",
+                  cmdline, (int)cpid);
         else
-          log_log(LOG_DEBUG, "nscd_invalidator: nscd -i %s (pid %d) failed (%d)",
-                  db, (int)cpid, i);
+          log_log(LOG_DEBUG, "invalidator: %s (pid %d) failed (%d)",
+                  cmdline, (int)cpid, i);
       }
       else if (WIFSIGNALED(status))
       {
         i = WTERMSIG(status);
-        log_log(LOG_ERR, "nscd_invalidator: nscd -i %s (pid %d) killed by %s (%d)",
-                db, (int)cpid, signame(i), i);
+        log_log(LOG_ERR, "invalidator: %s (pid %d) killed by %s (%d)",
+                cmdline, (int)cpid, signame(i), i);
       }
       else
-        log_log(LOG_ERR, "nscd_invalidator: nscd -i %s (pid %d) had unknown failure",
-                db, (int)cpid);
+        log_log(LOG_ERR, "invalidator: %s (pid %d) had unknown failure",
+                cmdline, (int)cpid);
       break;
   }
 }
 
 /* main loop for the invalidator process */
-static void nscd_handle_requests(int fd)
+static void handle_requests(int fd)
 {
   int i;
   uint8_t c;
   const char *db;
-  log_log(LOG_DEBUG, "nscd_invalidator: starting");
+  log_log(LOG_DEBUG, "invalidator: starting");
   /* set up environment */
   (void)chdir("/");
   putenv("PATH=/usr/sbin:/usr/bin:/sbin:/bin");
@@ -159,17 +162,17 @@ static void nscd_handle_requests(int fd)
     i = read(fd, &c, sizeof(uint8_t));
     if (i == 0)
     {
-      log_log(LOG_ERR, "nscd_invalidator: EOF");
+      log_log(LOG_ERR, "invalidator: EOF");
       _exit(EXIT_SUCCESS);
     }
     else if (i < 0)
     {
       if (errno == EINTR)
-        log_log(LOG_DEBUG, "nscd_invalidator: read failed (ignored): %s",
+        log_log(LOG_DEBUG, "invalidator: read failed (ignored): %s",
                 strerror(errno));
       else
       {
-        log_log(LOG_ERR, "nscd_invalidator: read failed: %s", strerror(errno));
+        log_log(LOG_ERR, "invalidator: read failed: %s", strerror(errno));
         _exit(EXIT_SUCCESS);
       }
     }
@@ -177,7 +180,7 @@ static void nscd_handle_requests(int fd)
     {
       db = map2name((enum ldap_map_selector)c);
       if (db == NULL)
-        log_log(LOG_ERR, "nscd_invalidator: invalid db received");
+        log_log(LOG_ERR, "invalidator: invalid db received");
       else
         exec_invalidate(db);
     }
@@ -185,8 +188,8 @@ static void nscd_handle_requests(int fd)
 }
 
 /* start a child process that holds onto the original privileges with the
-   sole purpose of running nscd -i commands */
-int nscd_start_invalidator(void)
+   purpose of running external cache invalidation commands */
+int invalidator_start(void)
 {
   int pipefds[2];
   pid_t cpid;
@@ -213,7 +216,7 @@ int nscd_start_invalidator(void)
     close(pipefds[1]);
     return -1;
   }
-  /* fork a child to perfrom the nscd invalidate commands */
+  /* fork a child to perfrom the invalidate commands */
   cpid = fork();
   if (cpid < 0)
   {
@@ -226,7 +229,7 @@ int nscd_start_invalidator(void)
   {
     /* we are the child: close the write end and handle requests */
     close(pipefds[1]);
-    nscd_handle_requests(pipefds[0]);
+    handle_requests(pipefds[0]);
     /* the handle function should't return */
     _exit(EXIT_FAILURE);
   }
@@ -236,19 +239,19 @@ int nscd_start_invalidator(void)
   return 0;
 }
 
-/* signal nscd to invalidate the selected map */
-void nscd_invalidate(enum ldap_map_selector map)
+/* signal invalidator to invalidate the selected external cache */
+void invalidator_do(enum ldap_map_selector map)
 {
   uint8_t c;
   int rc;
   if (signalfd < 0)
     return;
-  /* LM_NONE is used to signal all maps condigured in nscd_invalidate */
+  /* LM_NONE is used to signal all maps condigured in reconnect_invalidate */
   if (map == LM_NONE)
   {
     for (map = 0; map < LM_NONE ; map++)
-      if (nslcd_cfg->nscd_invalidate[map])
-        nscd_invalidate(map);
+        invalidator_do(map);
+      if (nslcd_cfg->reconnect_invalidate[map])
     return;
   }
   /* write a single byte which should be atomic and not fill the PIPE
@@ -257,6 +260,6 @@ void nscd_invalidate(enum ldap_map_selector map)
   c = (uint8_t)map;
   rc = write(signalfd, &c, sizeof(uint8_t));
   if (rc <= 0)
-    log_log(LOG_WARNING, "error signalling nscd invalidator: %s",
+    log_log(LOG_WARNING, "error signalling invalidator: %s",
             strerror(errno));
 }
diff --git a/nslcd/myldap.c b/nslcd/myldap.c
index 243ec9e..b2258d4 100644
--- a/nslcd/myldap.c
+++ b/nslcd/myldap.c
@@ -1197,8 +1197,8 @@ static int do_retry_search(MYLDAP_SEARCH *search)
           if ((current_uri->lastfail > 0) || (search->session->current_uri != start_uri))
           {
             log_log(LOG_INFO, "connected to LDAP server %s", current_uri->uri);
-            /* signal nscd cache invalidation */
-            nscd_invalidate(LM_NONE);
+            /* signal external invalidation of configured caches */
+            invalidator_do(LM_NONE);
           }
           /* update ok time */
           current_uri->firstfail = 0;
diff --git a/nslcd/nslcd.c b/nslcd/nslcd.c
index 0816647..8cc29c6 100644
--- a/nslcd/nslcd.c
+++ b/nslcd/nslcd.c
@@ -706,12 +706,12 @@ int main(int argc, char *argv[])
   if (!nslcd_debugging)
     log_startlogging();
   log_log(LOG_INFO, "version %s starting", VERSION);
-  /* start subprocess to do nscd invalidating if nscd_invalidate is set */
+  /* start subprocess to do invalidating if reconnect_invalidate is set */
   for (i = 0; i < LM_NONE; i++)
-    if (nslcd_cfg->nscd_invalidate[i])
+    if (nslcd_cfg->reconnect_invalidate[i])
       break;
   if (i < LM_NONE)
-    nscd_start_invalidator();
+    invalidator_start();
   /* write pidfile */
   create_pidfile(NSLCD_PIDFILE);
   /* install handler to close stuff off on exit and log notice */