common: Add a global variable to for the default error source.
[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  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21
22 #ifdef WITHOUT_NPTH /* Give the Makefile a chance to build without Pth.  */
23 #undef HAVE_NPTH
24 #undef USE_NPTH
25 #endif
26
27 #ifdef HAVE_W32_SYSTEM
28 #include <windows.h>
29 #endif
30 #ifdef HAVE_NPTH
31 #include <npth.h>
32 #endif
33 #ifdef HAVE_W32CE_SYSTEM
34 # include <assuan.h> /* For _assuan_w32ce_finish_pipe. */
35 #endif
36
37 #include "util.h"
38
39
40 /* The default error source of the application.  This is different
41    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
42    source file and thus is usable in code shared by applications.  */
43 gpg_err_source_t default_errsource;
44
45
46 #ifdef HAVE_W32CE_SYSTEM
47 static void parse_std_file_handles (int *argcp, char ***argvp);
48 static void
49 sleep_on_exit (void)
50 {
51   /* The sshd on CE swallows some of the command output.  Sleeping a
52      while usually helps.  */
53   Sleep (400);
54 }
55 #endif /*HAVE_W32CE_SYSTEM*/
56
57
58 /* If STRING is not NULL write string to es_stdout or es_stderr.  MODE
59    must be 1 or 2.  If STRING is NULL flush the respective stream.  */
60 static int
61 writestring_via_estream (int mode, const char *string)
62 {
63   if (mode == 1 || mode == 2)
64     {
65       if (string)
66         return es_fputs (string, mode == 1? es_stdout : es_stderr);
67       else
68         return es_fflush (mode == 1? es_stdout : es_stderr);
69     }
70   else
71     return -1;
72 }
73
74
75 /* This function is to be used early at program startup to make sure
76    that some subsystems are initialized.  This is in particular
77    important for W32 to initialize the sockets so that our socket
78    emulation code used directly as well as in libassuan may be used.
79    It should best be called before any I/O is done so that setup
80    required for logging is ready.  ARGCP and ARGVP are the addresses
81    of the parameters given to main.  This function may modify them.
82
83    This function should be called only via the macro
84    init_common_subsystems.
85
86    CAUTION: This might be called while running suid(root).  */
87 void
88 _init_common_subsystems (gpg_err_source_t errsource, int *argcp, char ***argvp)
89 {
90   /* Store the error source in a gloabl variable. */
91   default_errsource = errsource;
92
93   /* Try to auto set the character set.  */
94   set_native_charset (NULL);
95
96 #ifdef HAVE_W32_SYSTEM
97   /* For W32 we need to initialize the socket layer.  This is because
98      we use recv and send in libassuan as well as at some other
99      places.  If we are building with PTH we let pth_init do it.  We
100      can't do much on error so we ignore them.  An error would anyway
101      later pop up if one of the socket functions is used. */
102 # ifdef HAVE_NPTH
103   pth_init ();
104 # else
105   {
106     WSADATA wsadat;
107
108     WSAStartup (0x202, &wsadat);
109   }
110 # endif /*!HAVE_NPTH*/
111 #endif
112
113 #ifdef HAVE_W32CE_SYSTEM
114   /* Register the sleep exit function before the estream init so that
115      the sleep will be called after the estream registered atexit
116      function which flushes the left open estream streams and in
117      particular es_stdout.  */
118   atexit (sleep_on_exit);
119 #endif
120
121   /* Initialize the Estream library. */
122   es_init ();
123
124   /* Special hack for Windows CE: We extract some options from arg
125      to setup the standard handles.  */
126 #ifdef HAVE_W32CE_SYSTEM
127   parse_std_file_handles (argcp, argvp);
128 #else
129   (void)argcp;
130   (void)argvp;
131 #endif
132
133   /* Access the standard estreams as early as possible.  If we don't
134      do this the original stdio streams may have been closed when
135      _es_get_std_stream is first use and in turn it would connect to
136      the bit bucket.  */
137   {
138     int i;
139     for (i=0; i < 3; i++)
140       (void)_es_get_std_stream (i);
141   }
142
143   /* --version et al shall use estream as well.  */
144   argparse_register_outfnc (writestring_via_estream);
145 }
146
147
148
149 /* WindowsCE uses a very strange way of handling the standard streams.
150    There is a function SetStdioPath to associate a standard stream
151    with a file or a device but what we really want is to use pipes as
152    standard streams.  Despite that we implement pipes using a device,
153    we would have some limitations on the number of open pipes due to
154    the 3 character limit of device file name.  Thus we don't take this
155    path.  Another option would be to install a file system driver with
156    support for pipes; this would allow us to get rid of the device
157    name length limitation.  However, with GnuPG we can get away be
158    redefining the standard streams and passing the handles to be used
159    on the command line.  This has also the advantage that it makes
160    creating a process much easier and does not require the
161    SetStdioPath set and restore game.  The caller needs to pass the
162    rendezvous ids using up to three options:
163
164      -&S0=<rvid> -&S1=<rvid> -&S2=<rvid>
165
166    They are all optional but they must be the first arguments on the
167    command line.  Parsing stops as soon as an invalid option is found.
168    These rendezvous ids are then used to finish the pipe creation.*/
169 #ifdef HAVE_W32CE_SYSTEM
170 static void
171 parse_std_file_handles (int *argcp, char ***argvp)
172 {
173   int argc = *argcp;
174   char **argv = *argvp;
175   const char *s;
176   assuan_fd_t fd;
177   int i;
178   int fixup = 0;
179
180   if (!argc)
181     return;
182
183   for (argc--, argv++; argc; argc--, argv++)
184     {
185       s = *argv;
186       if (*s == '-' && s[1] == '&' && s[2] == 'S'
187           && (s[3] == '0' || s[3] == '1' || s[3] == '2')
188           && s[4] == '='
189           && (strchr ("-01234567890", s[5]) || !strcmp (s+5, "null")))
190         {
191           if (s[5] == 'n')
192             fd = ASSUAN_INVALID_FD;
193           else
194             fd = _assuan_w32ce_finish_pipe (atoi (s+5), s[3] != '0');
195           _es_set_std_fd (s[3] - '0', (int)fd);
196           fixup++;
197         }
198       else
199         break;
200     }
201
202   if (fixup)
203     {
204       argc = *argcp;
205       argc -= fixup;
206       *argcp = argc;
207
208       argv = *argvp;
209       for (i=1; i < argc; i++)
210         argv[i] = argv[i + fixup];
211       for (; i < argc + fixup; i++)
212         argv[i] = NULL;
213     }
214
215
216 }
217 #endif /*HAVE_W32CE_SYSTEM*/