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   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 static int
  89 cmd_sorter (const void *a1, const void *a2)
  90 {
  91   const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
  92   const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
  93   if (toupper (c1->shortName) > toupper (c2->shortName))
  94     return 1;
  95   if (toupper (c1->shortName) < toupper (c2->shortName))
  96     return -1;
  97   if (c1->shortName > c2->shortName)
  98     return 1;
  99   if (c1->shortName < c2->shortName)
 100     return -1;
 101   return 0;
 102 }
 103
 104
 105 /**
 106  * Run a standard GNUnet command startup sequence (initialize loggers
 107  * and configuration, parse options).
 108  *
 109  * @param argc number of command line arguments
 110  * @param argv command line arguments
 111  * @param binaryName our expected name
 112  * @param options command line options
 113  * @param task main function to run
 114  * @param task_cls closure for task
 115  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 116  */
 117 int
 118 GNUNET_PROGRAM_run (int argc,
 119                     char *const *argv,
 120                     const char *binaryName,
 121                     const char *binaryHelp,
 122                     const struct GNUNET_GETOPT_CommandLineOption *options,
 123                     GNUNET_PROGRAM_Main task, void *task_cls)
 124 {
 125   struct CommandContext cc;
 126   char *path;
 127   char *loglev;
 128   int ret;
 129   unsigned int cnt;
 130   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 131     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 132     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 133     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 134     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
 135   };
 136   struct GNUNET_GETOPT_CommandLineOption *allopts;
 137
 138   memset (&cc, 0, sizeof (cc));
 139   loglev = NULL;
 140   cc.task = task;
 141   cc.task_cls = task_cls;
 142   cc.cfg = GNUNET_CONFIGURATION_create ();
 143
 144   /* prepare */
 145 #if ENABLE_NLS
 146   setlocale (LC_ALL, "");
 147   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 148   if (path != NULL)
 149     {
 150       BINDTEXTDOMAIN ("GNUnet", path);
 151       GNUNET_free (path);
 152     }
 153   textdomain ("GNUnet");
 154 #endif
 155   cnt = 0;
 156   while (options[cnt].name != NULL)
 157     cnt++;
 158   allopts =
 159     GNUNET_malloc ((cnt +
 160                     1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 161                    sizeof (defoptions));
 162   memcpy (allopts, defoptions, sizeof (defoptions));
 163   memcpy (&allopts
 164           [sizeof (defoptions) /
 165            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 166           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 167   cnt +=
 168     sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 169   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 170          &cmd_sorter);
 171   loglev = GNUNET_strdup ("WARNING");
 172   if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,
 173                                        cc.cfg,
 174                                        allopts,
 175                                        (unsigned int) argc, argv))) ||
 176       ((GNUNET_OK !=
 177         GNUNET_log_setup (binaryName,
 178                           loglev,
 179                           NULL)) ||
 180        (GNUNET_OK != GNUNET_CONFIGURATION_load (cc.cfg, cc.cfgfile))))
 181
 182     {
 183       GNUNET_free_non_null (cc.cfgfile);
 184       GNUNET_free (loglev);
 185       GNUNET_free (allopts);
 186       return GNUNET_SYSERR;
 187     }
 188   GNUNET_free (allopts);
 189
 190   /* run */
 191   cc.args = &argv[ret];
 192   GNUNET_SCHEDULER_run (&program_main, &cc);
 193
 194   /* clean up */
 195   GNUNET_CONFIGURATION_destroy (cc.cfg);
 196   GNUNET_free_non_null (cc.cfgfile);
 197   GNUNET_free (loglev);
 198   return GNUNET_OK;
 199 }
 200
 201
 202 /* end of program.c */