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