Smallers steps to keep plugin running
[oweals/gnunet.git] / src / arm / gnunet-arm.c
index 740fd25338465163b0ea7f280f5c3e234b174ff0..7ec717a5adf4fa8251e757e632231fb4d89b0f1e 100644 (file)
@@ -4,7 +4,7 @@
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
 #include "platform.h"
 #include "gnunet_arm_service.h"
 #include "gnunet_client_lib.h"
+#include "gnunet_constants.h"
 #include "gnunet_getopt_lib.h"
 #include "gnunet_program_lib.h"
 #include "gnunet_time_lib.h"
 
 /**
- * Timeout for all operations.
+ * Timeout for stopping services.  Long to give some services a real chance.
  */
-#define TIMEOUT  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
+#define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
+
+/**
+ * Timeout for starting services, very short because of the strange way start works
+ * (by checking if running before starting, so really this time is always waited on
+ * startup (annoying)).
+ */
+#define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 50)
+
+/**
+ * Timeout for starting services, very short because of the strange way start works
+ * (by checking if running before starting, so really this time is always waited on
+ * startup (annoying)).
+ */
+#define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
 
 /**
  * Set if we are to shutdown all services (including ARM).
@@ -45,6 +60,21 @@ static int end;
  */
 static int start;
 
+/**
+ * Set if we are to stop/start default services (including ARM).
+ */
+static int restart;
+
+/**
+ * Set if we should delete configuration and temp directory on exit.
+ */
+static int delete;
+
+/**
+ * Set if we should not print status messages.
+ */
+static int quiet;
+
 /**
  * Set to the name of a service to start.
  */
@@ -60,12 +90,61 @@ static char *term;
  */
 static char *test;
 
+/**
+ * Set to the name of the config file used.
+ */
+static const char *config_file;
+
+/**
+ * Set to the directory where runtime files are stored.
+ */
+static char *dir;
+
 /**
  * Final status code.
  */
 static int ret;
 
+/**
+ * Connection with ARM.
+ */
+static struct GNUNET_ARM_Handle *h;
+
+/**
+ * Our scheduler.
+ */
+static struct GNUNET_SCHEDULER_Handle *sched;
+
+/**
+ * Our configuration.
+ */
+const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+/**
+ * Processing stage that we are in.  Simple counter.
+ */
+static unsigned int phase;
+
 
+/**
+ * Main continuation-passing-style loop.  Runs the various
+ * jobs that we've been asked to do in order.
+ *
+ * @param cls closure, unused
+ * @param tc context, unused
+ */
+static void
+cps_loop (void *cls,
+         const struct GNUNET_SCHEDULER_TaskContext *tc);
+
+
+/**
+ * Callback invoked with the status of the last operation.  Reports to the
+ * user and then runs the next phase in the FSM.
+ *
+ * @param cls pointer to "const char*" identifying service that was manipulated
+ * @param success GNUNET_OK if service is now running, GNUNET_NO if not, GNUNET_SYSERR on error
+ */
 static void
 confirm_cb (void *cls, int success)
 {
@@ -73,28 +152,66 @@ confirm_cb (void *cls, int success)
   switch (success)
     {
     case GNUNET_OK:
-      fprintf (stdout, _("Service `%s' is now running.\n"), service);
+      if (quiet != GNUNET_YES)
+        fprintf(stdout, _("Service `%s' is now running.\n"), service);
+      if ((phase - 1 != 2) && (phase - 1 != 3))
+        {
+          if (quiet != GNUNET_YES)
+            fprintf(stdout, _("Failed to stop service `%s'!\n"), service);
+          ret = 1;
+        }
       break;
     case GNUNET_NO:
-      fprintf (stdout, _("Service `%s' is not running.\n"), service);
+      if (quiet != GNUNET_YES)
+        fprintf(stdout, _("Service `%s' is not running.\n"), service);
+      if ((phase - 1 != 0) && (phase - 1 != 1))
+        {
+          if (quiet != GNUNET_YES)
+            fprintf(stdout, _("Failed to start service `%s'!\n"), service);
+          ret = 1;
+        }
       break;
     case GNUNET_SYSERR:
-      fprintf (stdout,
-               _("Error updating service `%s': ARM not running\n"), service);
+      if (quiet != GNUNET_YES)
+        fprintf(stdout,
+                _("Some error communicating with service `%s'.\n"), service);
+      ret = 1;
       break;
     }
+
+  GNUNET_SCHEDULER_add_continuation (sched,
+                                    &cps_loop,
+                                    NULL,
+                                    GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 }
 
 
+/**
+ * Function called to confirm that a service is running (or that
+ * it is not running).
+ *
+ * @param cls pointer to "const char*" identifying service that was manipulated
+ * @param tc reason determines if service is now running
+ */
 static void
 confirm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   const char *service = cls;
 
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
-    fprintf (stdout, _("Service `%s' is running.\n"), service);
+    {
+      if (quiet != GNUNET_YES)
+        fprintf(stdout, _("Service `%s' is running.\n"), service);
+    }
   else
-    fprintf (stdout, _("Service `%s' is not running.\n"), service);
+    {
+      if (quiet != GNUNET_YES)
+        fprintf(stdout, _("Service `%s' is not running.\n"), service);
+    }
+  GNUNET_SCHEDULER_add_continuation (sched,
+                                    &cps_loop,
+                                    NULL,
+                                    GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 }
 
 
@@ -102,61 +219,144 @@ confirm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * Main function that will be run by the scheduler.
  *
  * @param cls closure
- * @param sched the scheduler to use
+ * @param s the scheduler to use
  * @param args remaining command-line arguments
  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
- * @param cfg configuration
+ * @param c configuration
  */
 static void
 run (void *cls,
-     struct GNUNET_SCHEDULER_Handle *sched,
+     struct GNUNET_SCHEDULER_Handle *s,
      char *const *args,
-     const char *cfgfile, 
-     const struct GNUNET_CONFIGURATION_Handle *cfg)
+     const char *cfgfile,
+     const struct GNUNET_CONFIGURATION_Handle *c)
 {
-  if (term != NULL)
-    {
-      GNUNET_ARM_stop_service (term, cfg, sched, TIMEOUT, &confirm_cb, term);
-    }
-  if (end)
-    {
-      GNUNET_ARM_stop_service ("arm",
-                               cfg, sched, TIMEOUT, &confirm_cb, "arm");
-    }
-  if (start)
-    {
-      GNUNET_ARM_start_service ("arm",
-                                cfg, sched, TIMEOUT, &confirm_cb, "arm");
-    }
-  if (init != NULL)
+  sched = s;
+  cfg = c;
+  config_file = cfgfile;
+  if (GNUNET_CONFIGURATION_get_value_string(cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
     {
-      GNUNET_ARM_start_service (init, cfg, sched, TIMEOUT, &confirm_cb, init);
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                 _("Fatal configuration error: `%s' option in section `%s' missing.\n"),
+                 "SERVICEHOME",
+                 "PATHS");
+      return;
     }
-  if (test != NULL)
+  h = GNUNET_ARM_connect (cfg, sched, NULL);
+  if (h == NULL)
     {
-      GNUNET_CLIENT_service_test (sched,
-                                  test, cfg, TIMEOUT, &confirm_task, test);
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+              _("Fatal error initializing ARM API.\n"));
+      ret = 1;
+      return;
     }
+  GNUNET_SCHEDULER_add_continuation (sched,
+                                    &cps_loop,
+                                    NULL,
+                                    GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 }
 
+/**
+ * Attempts to delete configuration file and SERVICEHOME
+ * on arm shutdown provided the end and delete options
+ * were specified when gnunet-arm was run.
+ */
+static void delete_files()
+{
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Will attempt to remove configuration file %s and service directory %s\n", config_file, dir);
+
+  if (UNLINK(config_file) != 0)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+           _("Failed to remove configuration file %s\n"), config_file);
+  }
+
+  if (GNUNET_DISK_directory_remove(dir) != GNUNET_OK)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+        _("Failed to remove servicehome directory %s\n"), dir);
+
+  }
+}
 
 /**
- * gnunet-arm command line options
+ * Main continuation-passing-style loop.  Runs the various
+ * jobs that we've been asked to do in order.
+ *
+ * @param cls closure, unused
+ * @param tc context, unused
  */
-static struct GNUNET_GETOPT_CommandLineOption options[] = {
-  {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
-   GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
-  {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
-   GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
-  {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
-   GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
-  {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
-   GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
-  {'t', "test", "SERVICE",
-   gettext_noop ("test if a particular service is running"),
-   GNUNET_YES, &GNUNET_GETOPT_set_string, &test},
-  GNUNET_GETOPT_OPTION_END
-};
+static void
+cps_loop (void *cls,
+         const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  while (1)
+    {
+      switch (phase++)
+       {
+       case 0:
+         if (term != NULL)
+           {
+             GNUNET_ARM_stop_service (h, term, STOP_TIMEOUT, &confirm_cb, term);
+             return;
+           }
+         break;
+       case 1:
+         if ((end) || (restart))
+           {
+             GNUNET_ARM_stop_service (h, "arm", STOP_TIMEOUT, &confirm_cb, "arm");
+             return;
+           }
+         break;
+       case 2:
+         if (start)
+           {
+             GNUNET_ARM_start_service (h, "arm", START_TIMEOUT, &confirm_cb, "arm");
+             return;
+           }
+         break;
+       case 3:
+         if (init != NULL)
+           {
+             GNUNET_ARM_start_service (h, init, START_TIMEOUT, &confirm_cb, init);
+             return;
+           }
+         break;
+       case 4:
+         if (test != NULL)
+           {
+             GNUNET_CLIENT_service_test (sched, test, cfg, TEST_TIMEOUT, &confirm_task, test);
+             return;
+           }
+         break;
+       case 5:
+         if (restart)
+           {
+              GNUNET_ARM_disconnect (h);
+              phase = 0;
+              end = 0;
+              start = 1;
+              restart = 0;
+              h = GNUNET_ARM_connect (cfg, sched, NULL);
+              if (h == NULL)
+                {
+                  GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                           _("Fatal error initializing ARM API.\n"));
+                  ret = 1;
+                  return;
+                }
+              GNUNET_SCHEDULER_add_now(sched, &cps_loop, NULL);
+              return;
+           }
+         /* Fall through */
+       default: /* last phase */
+         GNUNET_ARM_disconnect (h);
+         if ((end == GNUNET_YES) && (delete == GNUNET_YES))
+           delete_files();
+         return;
+       }
+    }
+}
 
 
 /**
@@ -169,13 +369,38 @@ static struct GNUNET_GETOPT_CommandLineOption options[] = {
 int
 main (int argc, char *const *argv)
 {
-  return (GNUNET_OK ==
-          GNUNET_PROGRAM_run (argc,
-                              argv,
-                              "gnunet-arm",
-                              gettext_noop
-                              ("Control services and the Automated Restart Manager (ARM)"),
-                              options, &run, NULL)) ? ret : 1;
+  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
+    {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
+    {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
+     GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
+    {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
+     GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
+    {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
+    {'r', "restart", NULL, gettext_noop ("stop and start all GNUnet default services"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
+    {'t', "test", "SERVICE",
+     gettext_noop ("test if a particular service is running"),
+     GNUNET_YES, &GNUNET_GETOPT_set_string, &test},
+    {'d', "delete", NULL, gettext_noop ("delete config file and directory on exit"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
+    {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
+    GNUNET_GETOPT_OPTION_END
+  };
+
+  if (GNUNET_OK == GNUNET_PROGRAM_run (argc,
+                      argv,
+                      "gnunet-arm",
+                      gettext_noop
+                      ("Control services and the Automated Restart Manager (ARM)"),
+                      options, &run, NULL))
+    {
+      return ret;
+    }
+
+    return 1;
 }
 
 /* end of gnunet-arm.c */