aa272ea96df344cf231435bca8c3b4bcb895d685
[oweals/gnunet.git] / 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 (c1->shortName) > toupper (c2->shortName))
97     return 1;
98   if (toupper (c1->shortName) < toupper (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   int ret;
133   unsigned int cnt;
134   struct GNUNET_CONFIGURATION_Handle *cfg;
135   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
136     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
137     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
138     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
139     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
140   };
141   struct GNUNET_GETOPT_CommandLineOption *allopts;
142
143   memset (&cc, 0, sizeof (cc));
144   loglev = NULL;
145   cc.task = task;
146   cc.task_cls = task_cls;
147   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
148
149   /* prepare */
150 #if ENABLE_NLS
151   setlocale (LC_ALL, "");
152   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
153   if (path != NULL)
154     {
155       BINDTEXTDOMAIN ("GNUnet", path);
156       GNUNET_free (path);
157     }
158   textdomain ("GNUnet");
159 #endif
160   cnt = 0;
161   while (options[cnt].name != NULL)
162     cnt++;
163   allopts =
164     GNUNET_malloc ((cnt +
165                     1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
166                    sizeof (defoptions));
167   memcpy (allopts, defoptions, sizeof (defoptions));
168   memcpy (&allopts
169           [sizeof (defoptions) /
170            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
171           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
172   cnt +=
173     sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
174   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
175          &cmd_sorter);
176   loglev = GNUNET_strdup ("WARNING");
177   if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,                                      
178                                        allopts,
179                                        (unsigned int) argc, argv))) ||
180       ((GNUNET_OK !=
181         GNUNET_log_setup (binaryName,
182                           loglev,
183                           NULL)) ||
184        (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))))
185
186     {
187       GNUNET_free_non_null (cc.cfgfile);
188       GNUNET_free (loglev);
189       GNUNET_free (allopts);
190       return GNUNET_SYSERR;
191     }
192   GNUNET_free (allopts);
193
194   /* run */
195   cc.args = &argv[ret];
196   GNUNET_SCHEDULER_run (&program_main, &cc);
197
198   /* clean up */
199   GNUNET_CONFIGURATION_destroy (cfg);
200   GNUNET_free_non_null (cc.cfgfile);
201   GNUNET_free (loglev);
202   return GNUNET_OK;
203 }
204
205
206 /* end of program.c */