src/util/program.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/program.c
  23  * @brief standard code for GNUnet startup and shutdown
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_configuration_lib.h"
  30 #include "gnunet_crypto_lib.h"
  31 #include "gnunet_directories.h"
  32 #include "gnunet_getopt_lib.h"
  33 #include "gnunet_os_lib.h"
  34 #include "gnunet_program_lib.h"
  35 #include "gnunet_resolver_service.h"
  36 #include "gnunet_scheduler_lib.h"
  37 #include <gcrypt.h>
  38
  39 /**
  40  * Context for the command.
  41  */
  42 struct CommandContext
  43 {
  44   /**
  45    * Argv argument.
  46    */
  47   char *const *args;
  48
  49   /**
  50    * Name of the configuration file used, can be NULL!
  51    */
  52   char *cfgfile;
  53
  54   /**
  55    * Main function to run.
  56    */
  57   GNUNET_PROGRAM_Main task;
  58
  59   /**
  60    * Closure for task.
  61    */
  62   void *task_cls;
  63
  64   /**
  65    * Configuration to use.
  66    */
  67   const struct GNUNET_CONFIGURATION_Handle *cfg;
  68
  69 };
  70
  71
  72 /**
  73  * Initial task called by the scheduler for each
  74  * program.  Runs the program-specific main task.
  75  */
  76 static void
  77 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  78 {
  79   struct CommandContext *cc = cls;
  80
  81   GNUNET_RESOLVER_connect (cc->cfg);
  82   cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
  83 }
  84
  85
  86 /**
  87  * Compare function for 'qsort' to sort command-line arguments by the
  88  * short option.
  89  *
  90  * @param a1 first command line option
  91  * @param a2 second command line option
  92  */
  93 static int
  94 cmd_sorter (__const void *a1, __const void *a2)
  95 {
  96   __const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
  97   __const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
  98
  99   if (toupper ((unsigned char) c1->shortName) >
 100       toupper ((unsigned char) c2->shortName))
 101     return 1;
 102   if (toupper ((unsigned char) c1->shortName) <
 103       toupper ((unsigned char) c2->shortName))
 104     return -1;
 105   if (c1->shortName > c2->shortName)
 106     return 1;
 107   if (c1->shortName < c2->shortName)
 108     return -1;
 109   return 0;
 110 }
 111
 112
 113 /**
 114  * Run a standard GNUnet command startup sequence (initialize loggers
 115  * and configuration, parse options).
 116  *
 117  * @param argc number of command line arguments
 118  * @param argv command line arguments
 119  * @param binaryName our expected name
 120  * @param binaryHelp help text for the program
 121  * @param options command line options
 122  * @param task main function to run
 123  * @param task_cls closure for task
 124  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 125  */
 126 int
 127 GNUNET_PROGRAM_run (int argc,
 128                     char *const *argv,
 129                     const char *binaryName,
 130                     const char *binaryHelp,
 131                     const struct GNUNET_GETOPT_CommandLineOption *options,
 132                     GNUNET_PROGRAM_Main task, void *task_cls)
 133 {
 134   struct CommandContext cc;
 135   char *path;
 136   char *loglev;
 137   char *logfile;
 138   int ret;
 139   unsigned int cnt;
 140   unsigned long long skew_offset;
 141   unsigned long long skew_variance;
 142   long long clock_offset;
 143   struct GNUNET_CONFIGURATION_Handle *cfg;
 144
 145   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 146     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 147     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 148     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 149     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
 150     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
 151   };
 152   struct GNUNET_GETOPT_CommandLineOption *allopts;
 153   const char *gargs;
 154   char *lpfx;
 155   char *spc;
 156
 157   logfile = NULL;
 158   gargs = getenv ("GNUNET_ARGS");
 159   if (gargs != NULL)
 160   {
 161     char **gargv;
 162     unsigned int gargc;
 163     int i;
 164     char *tok;
 165     char *cargs;
 166
 167     gargv = NULL;
 168     gargc = 0;
 169     for (i = 0; i < argc; i++)
 170       GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
 171     cargs = GNUNET_strdup (gargs);
 172     tok = strtok (cargs, " ");
 173     while (NULL != tok)
 174     {
 175       GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
 176       tok = strtok (NULL, " ");
 177     }
 178     GNUNET_free (cargs);
 179     GNUNET_array_append (gargv, gargc, NULL);
 180     argv = (char *const *) gargv;
 181     argc = gargc - 1;
 182   }
 183   memset (&cc, 0, sizeof (cc));
 184   loglev = NULL;
 185   cc.task = task;
 186   cc.task_cls = task_cls;
 187   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 188
 189   /* prepare */
 190 #if ENABLE_NLS
 191   setlocale (LC_ALL, "");
 192   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 193   if (path != NULL)
 194   {
 195     BINDTEXTDOMAIN ("GNUnet", path);
 196     GNUNET_free (path);
 197   }
 198   textdomain ("GNUnet");
 199 #endif
 200   cnt = 0;
 201   while (options[cnt].name != NULL)
 202     cnt++;
 203   allopts =
 204       GNUNET_malloc ((cnt +
 205                       1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 206                      sizeof (defoptions));
 207   memcpy (allopts, defoptions, sizeof (defoptions));
 208   memcpy (&allopts
 209           [sizeof (defoptions) /
 210            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 211           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 212   cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 213   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 214          &cmd_sorter);
 215   loglev = GNUNET_strdup ("WARNING");
 216   cc.cfgfile = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
 217   lpfx = GNUNET_strdup (binaryName);
 218   if (NULL != (spc = strstr (lpfx, " ")))
 219     *spc = '\0';
 220   if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,
 221                                        allopts,
 222                                        (unsigned int) argc, argv))) ||
 223       ((GNUNET_OK !=
 224         GNUNET_log_setup (lpfx,
 225                           loglev,
 226                           logfile)) ||
 227        (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))))
 228   {
 229     GNUNET_CONFIGURATION_destroy (cfg);
 230     GNUNET_free_non_null (cc.cfgfile);
 231     GNUNET_free (loglev);
 232     GNUNET_free (allopts);
 233     GNUNET_free (lpfx);
 234     return GNUNET_SYSERR;
 235   }
 236   GNUNET_free (allopts);
 237   GNUNET_free (lpfx);
 238   if (GNUNET_OK ==
 239       GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
 240                                              &skew_offset) &&
 241       (GNUNET_OK ==
 242        GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
 243                                               "skew_variance", &skew_variance)))
 244   {
 245     clock_offset = skew_offset - skew_variance;
 246     GNUNET_TIME_set_offset (clock_offset);
 247   }
 248   /* run */
 249   cc.args = &argv[ret];
 250   GNUNET_SCHEDULER_run (&program_main, &cc);
 251
 252   /* clean up */
 253   GNUNET_CONFIGURATION_destroy (cfg);
 254   GNUNET_free_non_null (cc.cfgfile);
 255   GNUNET_free (loglev);
 256   return GNUNET_OK;
 257 }
 258
 259
 260 /* end of program.c */