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   if (toupper ( (unsigned char) c1->shortName) > toupper ( (unsigned char) c2->shortName))
  99     return 1;
 100   if (toupper ( (unsigned char) c1->shortName) < toupper ( (unsigned char) c2->shortName))
 101     return -1;
 102   if (c1->shortName > c2->shortName)
 103     return 1;
 104   if (c1->shortName < c2->shortName)
 105     return -1;
 106   return 0;
 107 }
 108
 109
 110 /**
 111  * Run a standard GNUnet command startup sequence (initialize loggers
 112  * and configuration, parse options).
 113  *
 114  * @param argc number of command line arguments
 115  * @param argv command line arguments
 116  * @param binaryName our expected name
 117  * @param binaryHelp help text for the program
 118  * @param options command line options
 119  * @param task main function to run
 120  * @param task_cls closure for task
 121  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 122  */
 123 int
 124 GNUNET_PROGRAM_run (int argc,
 125                     char *const *argv,
 126                     const char *binaryName,
 127                     const char *binaryHelp,
 128                     const struct GNUNET_GETOPT_CommandLineOption *options,
 129                     GNUNET_PROGRAM_Main task, void *task_cls)
 130 {
 131   struct CommandContext cc;
 132   char *path;
 133   char *loglev;
 134   char *logfile;
 135   int ret;
 136   unsigned int cnt;
 137   struct GNUNET_CONFIGURATION_Handle *cfg;
 138   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 139     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 140     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 141     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 142     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
 143     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
 144   };
 145   struct GNUNET_GETOPT_CommandLineOption *allopts;
 146   const char *gargs;
 147   char *lpfx;
 148   char *spc;
 149
 150   logfile = NULL;
 151   gargs = getenv ("GNUNET_ARGS");
 152   if (gargs != NULL)
 153     {
 154       char **gargv;
 155       unsigned int gargc;
 156       int i;
 157       char *tok;
 158       char *cargs;
 159
 160       gargv = NULL;
 161       gargc = 0;
 162       for (i=0;i<argc;i++)
 163         GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
 164       cargs = GNUNET_strdup (gargs);
 165       tok = strtok (cargs, " ");
 166       while (NULL != tok)
 167         {
 168           GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
 169           tok = strtok (NULL, " ");
 170         }
 171       GNUNET_free (cargs);
 172       GNUNET_array_append (gargv, gargc, NULL);
 173       argv = (char *const *) gargv;
 174       argc = gargc - 1;
 175     }
 176   memset (&cc, 0, sizeof (cc));
 177   loglev = NULL;
 178   cc.task = task;
 179   cc.task_cls = task_cls;
 180   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 181
 182   /* prepare */
 183 #if ENABLE_NLS
 184   setlocale (LC_ALL, "");
 185   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 186   if (path != NULL)
 187     {
 188       BINDTEXTDOMAIN ("GNUnet", path);
 189       GNUNET_free (path);
 190     }
 191   textdomain ("GNUnet");
 192 #endif
 193   cnt = 0;
 194   while (options[cnt].name != NULL)
 195     cnt++;
 196   allopts =
 197     GNUNET_malloc ((cnt +
 198                     1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 199                    sizeof (defoptions));
 200   memcpy (allopts, defoptions, sizeof (defoptions));
 201   memcpy (&allopts
 202           [sizeof (defoptions) /
 203            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 204           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 205   cnt +=
 206     sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 207   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 208          &cmd_sorter);
 209   loglev = GNUNET_strdup ("WARNING");
 210   cc.cfgfile = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
 211   lpfx = GNUNET_strdup (binaryName);
 212   if (NULL != (spc = strstr (lpfx, " ")))
 213     *spc = '\0';
 214   if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,
 215                                        allopts,
 216                                        (unsigned int) argc, argv))) ||
 217       ((GNUNET_OK !=
 218         GNUNET_log_setup (lpfx,
 219                           loglev,
 220                           logfile)) ||
 221        (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))))
 222     {
 223       GNUNET_CONFIGURATION_destroy (cfg);
 224       GNUNET_free_non_null (cc.cfgfile);
 225       GNUNET_free (loglev);
 226       GNUNET_free (allopts);
 227       GNUNET_free (lpfx);
 228       return GNUNET_SYSERR;
 229     }
 230   GNUNET_free (allopts);
 231   GNUNET_free (lpfx);
 232
 233   /* run */
 234   cc.args = &argv[ret];
 235   GNUNET_SCHEDULER_run (&program_main, &cc);
 236
 237   /* clean up */
 238   GNUNET_CONFIGURATION_destroy (cfg);
 239   GNUNET_free_non_null (cc.cfgfile);
 240   GNUNET_free (loglev);
 241   return GNUNET_OK;
 242 }
 243
 244
 245 /* end of program.c */