tools: Call sendmail directly from the wks tools.
[gnupg.git] / common / init.c
1 /* init.c - Various initializations
2  *      Copyright (C) 2007 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <http://www.gnu.org/licenses/>.
28  */
29
30 #include <config.h>
31
32 #ifdef WITHOUT_NPTH /* Give the Makefile a chance to build without Pth.  */
33 #undef HAVE_NPTH
34 #undef USE_NPTH
35 #endif
36
37 #ifdef HAVE_W32_SYSTEM
38 # ifdef HAVE_WINSOCK2_H
39 #  include <winsock2.h>
40 # endif
41 # include <windows.h>
42 #endif
43 #ifdef HAVE_NPTH
44 # include <npth.h>
45 #endif
46 #ifdef HAVE_W32CE_SYSTEM
47 # include <assuan.h> /* For _assuan_w32ce_finish_pipe. */
48 #endif
49
50 #include "util.h"
51
52 /* This object is used to register memory cleanup functions.
53    Technically they are not needed but they can avoid frequent
54    questions about un-released memory.  Note that we use the system
55    malloc and not any wrappers.  */
56 struct mem_cleanup_item_s;
57 typedef struct mem_cleanup_item_s *mem_cleanup_item_t;
58
59 struct mem_cleanup_item_s
60 {
61   mem_cleanup_item_t next;
62   void (*func) (void);
63 };
64
65 static mem_cleanup_item_t mem_cleanup_list;
66
67
68 /* The default error source of the application.  This is different
69    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
70    source file and thus is usable in code shared by applications.
71    Note that we need to initialize it because otherwise some linkers
72    (OS X at least) won't find the symbol when linking the t-*.c
73    files.  */
74 gpg_err_source_t default_errsource = 0;
75
76
77 #ifdef HAVE_W32CE_SYSTEM
78 static void parse_std_file_handles (int *argcp, char ***argvp);
79 static void
80 sleep_on_exit (void)
81 {
82   /* The sshd on CE swallows some of the command output.  Sleeping a
83      while usually helps.  */
84   Sleep (400);
85 }
86 #endif /*HAVE_W32CE_SYSTEM*/
87
88
89 static void
90 run_mem_cleanup (void)
91 {
92   mem_cleanup_item_t next;
93
94   while (mem_cleanup_list)
95     {
96       next = mem_cleanup_list->next;
97       mem_cleanup_list->func ();
98       free (mem_cleanup_list);
99       mem_cleanup_list = next;
100     }
101 }
102
103
104 void
105 register_mem_cleanup_func (void (*func)(void))
106 {
107   mem_cleanup_item_t item;
108
109   for (item = mem_cleanup_list; item; item = item->next)
110     if (item->func == func)
111       return; /* Function has already been registered.  */
112
113   item = malloc (sizeof *item);
114   if (item)
115     {
116       item->func = func;
117       item->next = mem_cleanup_list;
118       mem_cleanup_list = item;
119     }
120 }
121
122
123 /* If STRING is not NULL write string to es_stdout or es_stderr.  MODE
124    must be 1 or 2.  If STRING is NULL flush the respective stream.  */
125 static int
126 writestring_via_estream (int mode, const char *string)
127 {
128   if (mode == 1 || mode == 2)
129     {
130       if (string)
131         return es_fputs (string, mode == 1? es_stdout : es_stderr);
132       else
133         return es_fflush (mode == 1? es_stdout : es_stderr);
134     }
135   else
136     return -1;
137 }
138
139
140 /* This function should be the first called after main.  */
141 void
142 early_system_init (void)
143 {
144 }
145
146
147 /* This function is to be used early at program startup to make sure
148    that some subsystems are initialized.  This is in particular
149    important for W32 to initialize the sockets so that our socket
150    emulation code used directly as well as in libassuan may be used.
151    It should best be called before any I/O is done so that setup
152    required for logging is ready.  ARGCP and ARGVP are the addresses
153    of the parameters given to main.  This function may modify them.
154
155    This function should be called only via the macro
156    init_common_subsystems.
157
158    CAUTION: This might be called while running suid(root).  */
159 void
160 _init_common_subsystems (gpg_err_source_t errsource, int *argcp, char ***argvp)
161 {
162   /* Store the error source in a global variable. */
163   default_errsource = errsource;
164
165   atexit (run_mem_cleanup);
166
167   /* Try to auto set the character set.  */
168   set_native_charset (NULL);
169
170 #ifdef HAVE_W32_SYSTEM
171   /* For W32 we need to initialize the socket layer.  This is because
172      we use recv and send in libassuan as well as at some other
173      places.  */
174   {
175     WSADATA wsadat;
176
177     WSAStartup (0x202, &wsadat);
178   }
179 #endif
180
181 #ifdef HAVE_W32CE_SYSTEM
182   /* Register the sleep exit function before the estream init so that
183      the sleep will be called after the estream registered atexit
184      function which flushes the left open estream streams and in
185      particular es_stdout.  */
186   atexit (sleep_on_exit);
187 #endif
188
189   /* Initialize the Estream library. */
190   gpgrt_init ();
191   gpgrt_set_alloc_func (gcry_realloc);
192 #ifdef USE_NPTH
193   gpgrt_set_syscall_clamp (npth_unprotect, npth_protect);
194 #endif
195
196   /* Special hack for Windows CE: We extract some options from arg
197      to setup the standard handles.  */
198 #ifdef HAVE_W32CE_SYSTEM
199   parse_std_file_handles (argcp, argvp);
200 #else
201   (void)argcp;
202   (void)argvp;
203 #endif
204
205   /* Access the standard estreams as early as possible.  If we don't
206      do this the original stdio streams may have been closed when
207      _es_get_std_stream is first use and in turn it would connect to
208      the bit bucket.  */
209   {
210     int i;
211     for (i=0; i < 3; i++)
212       (void)_gpgrt_get_std_stream (i);
213   }
214
215   /* --version et al shall use estream as well.  */
216   argparse_register_outfnc (writestring_via_estream);
217 }
218
219
220
221 /* WindowsCE uses a very strange way of handling the standard streams.
222    There is a function SetStdioPath to associate a standard stream
223    with a file or a device but what we really want is to use pipes as
224    standard streams.  Despite that we implement pipes using a device,
225    we would have some limitations on the number of open pipes due to
226    the 3 character limit of device file name.  Thus we don't take this
227    path.  Another option would be to install a file system driver with
228    support for pipes; this would allow us to get rid of the device
229    name length limitation.  However, with GnuPG we can get away be
230    redefining the standard streams and passing the handles to be used
231    on the command line.  This has also the advantage that it makes
232    creating a process much easier and does not require the
233    SetStdioPath set and restore game.  The caller needs to pass the
234    rendezvous ids using up to three options:
235
236      -&S0=<rvid> -&S1=<rvid> -&S2=<rvid>
237
238    They are all optional but they must be the first arguments on the
239    command line.  Parsing stops as soon as an invalid option is found.
240    These rendezvous ids are then used to finish the pipe creation.*/
241 #ifdef HAVE_W32CE_SYSTEM
242 static void
243 parse_std_file_handles (int *argcp, char ***argvp)
244 {
245   int argc = *argcp;
246   char **argv = *argvp;
247   const char *s;
248   assuan_fd_t fd;
249   int i;
250   int fixup = 0;
251
252   if (!argc)
253     return;
254
255   for (argc--, argv++; argc; argc--, argv++)
256     {
257       s = *argv;
258       if (*s == '-' && s[1] == '&' && s[2] == 'S'
259           && (s[3] == '0' || s[3] == '1' || s[3] == '2')
260           && s[4] == '='
261           && (strchr ("-01234567890", s[5]) || !strcmp (s+5, "null")))
262         {
263           if (s[5] == 'n')
264             fd = ASSUAN_INVALID_FD;
265           else
266             fd = _assuan_w32ce_finish_pipe (atoi (s+5), s[3] != '0');
267           _es_set_std_fd (s[3] - '0', (int)fd);
268           fixup++;
269         }
270       else
271         break;
272     }
273
274   if (fixup)
275     {
276       argc = *argcp;
277       argc -= fixup;
278       *argcp = argc;
279
280       argv = *argvp;
281       for (i=1; i < argc; i++)
282         argv[i] = argv[i + fixup];
283       for (; i < argc + fixup; i++)
284         argv[i] = NULL;
285     }
286
287
288 }
289 #endif /*HAVE_W32CE_SYSTEM*/