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_scheduler_lib.h"
  36 #include <gcrypt.h>
  37
  38 #if HAVE_ARGZ_H
  39 #include <argz.h>
  40 #else
  41 #include "program_lib_strnlen.c"
  42 #include "program_lib_strndup.c"
  43 #include "program_lib_mempcpy.c"
  44 #include "program_lib_argz.c"
  45 #endif
  46
  47 /**
  48  * Context for the command.
  49  */
  50 struct CommandContext
  51 {
  52   /**
  53    * Argv argument.
  54    */
  55   char *const *args;
  56
  57   /**
  58    * Name of the configuration file used, can be NULL!
  59    */
  60   char *cfgfile;
  61
  62   /**
  63    * Main function to run.
  64    */
  65   GNUNET_PROGRAM_Main task;
  66
  67   /**
  68    * Closure for task.
  69    */
  70   void *task_cls;
  71
  72   /**
  73    * Configuration to use.
  74    */
  75   const struct GNUNET_CONFIGURATION_Handle *cfg;
  76
  77 };
  78
  79
  80 /**
  81  * Initial task called by the scheduler for each
  82  * program.  Runs the program-specific main task.
  83  */
  84 static void
  85 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  86 {
  87   struct CommandContext *cc = cls;
  88
  89   cc->task (cc->task_cls, tc->sched, cc->args, cc->cfgfile, cc->cfg);
  90 }
  91
  92
  93 /**
  94  * Compare function for 'qsort' to sort command-line arguments by the
  95  * short option.
  96  *
  97  * @param a1 first command line option
  98  * @param a2 second command line option
  99  */
 100 static int
 101 cmd_sorter (__const void *a1, __const void *a2)
 102 {
 103   __const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
 104   __const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
 105   if (toupper (c1->shortName) > toupper (c2->shortName))
 106     return 1;
 107   if (toupper (c1->shortName) < toupper (c2->shortName))
 108     return -1;
 109   if (c1->shortName > c2->shortName)
 110     return 1;
 111   if (c1->shortName < c2->shortName)
 112     return -1;
 113   return 0;
 114 }
 115
 116
 117 /**
 118  * Run a standard GNUnet command startup sequence (initialize loggers
 119  * and configuration, parse options).
 120  *
 121  * @param argc number of command line arguments
 122  * @param argv command line arguments
 123  * @param binaryName our expected name
 124  * @param binaryHelp help text for the program
 125  * @param options command line options
 126  * @param task main function to run
 127  * @param task_cls closure for task
 128  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 129  */
 130 int
 131 GNUNET_PROGRAM_run (int argc,
 132                     char *const *argv,
 133                     const char *binaryName,
 134                     const char *binaryHelp,
 135                     const struct GNUNET_GETOPT_CommandLineOption *options,
 136                     GNUNET_PROGRAM_Main task, void *task_cls)
 137 {
 138   struct CommandContext cc;
 139   char *path;
 140   char *loglev;
 141   int ret;
 142   unsigned int cnt;
 143   struct GNUNET_CONFIGURATION_Handle *cfg;
 144   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 145     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 146     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 147     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 148     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
 149   };
 150   struct GNUNET_GETOPT_CommandLineOption *allopts;
 151   const char *gargs;
 152
 153   gargs = getenv ("GNUNET_ARGS");
 154   if (gargs != NULL)
 155     {
 156       char *gargz;
 157       size_t gargl;
 158       char **gargv;
 159       int i;
 160
 161       argz_create_sep (gargs, ' ', &gargz, &gargl);
 162       for (i=0;i<argc;i++)
 163         argz_insert (&gargz, &gargl, gargz, argv[i]);
 164       gargv = GNUNET_malloc (sizeof (char*) * (gargl+1));
 165       argz_extract (gargz, gargl, gargv);
 166       argc = argz_count (gargz, gargl);
 167       free (gargz);
 168       argv = (char *const *) gargv;
 169     }
 170   memset (&cc, 0, sizeof (cc));
 171   loglev = NULL;
 172   cc.task = task;
 173   cc.task_cls = task_cls;
 174   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 175
 176   /* prepare */
 177 #if ENABLE_NLS
 178   setlocale (LC_ALL, "");
 179   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 180   if (path != NULL)
 181     {
 182       BINDTEXTDOMAIN ("GNUnet", path);
 183       GNUNET_free (path);
 184     }
 185   textdomain ("GNUnet");
 186 #endif
 187   cnt = 0;
 188   while (options[cnt].name != NULL)
 189     cnt++;
 190   allopts =
 191     GNUNET_malloc ((cnt +
 192                     1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 193                    sizeof (defoptions));
 194   memcpy (allopts, defoptions, sizeof (defoptions));
 195   memcpy (&allopts
 196           [sizeof (defoptions) /
 197            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 198           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 199   cnt +=
 200     sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 201   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 202          &cmd_sorter);
 203   loglev = GNUNET_strdup ("WARNING");
 204   if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,
 205                                        allopts,
 206                                        (unsigned int) argc, argv))) ||
 207       ((GNUNET_OK !=
 208         GNUNET_log_setup (binaryName,
 209                           loglev,
 210                           NULL)) ||
 211        (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))))
 212
 213     {
 214       GNUNET_free_non_null (cc.cfgfile);
 215       GNUNET_free (loglev);
 216       GNUNET_free (allopts);
 217       return GNUNET_SYSERR;
 218     }
 219   GNUNET_free (allopts);
 220
 221   /* run */
 222   cc.args = &argv[ret];
 223   GNUNET_SCHEDULER_run (&program_main, &cc);
 224
 225   /* clean up */
 226   GNUNET_CONFIGURATION_destroy (cfg);
 227   GNUNET_free_non_null (cc.cfgfile);
 228   GNUNET_free (loglev);
 229   return GNUNET_OK;
 230 }
 231
 232
 233 /* end of program.c */