w32: Add icons and version information.
[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 #include <windows.h>
39 #endif
40 #ifdef HAVE_NPTH
41 #include <npth.h>
42 #endif
43 #ifdef HAVE_W32CE_SYSTEM
44 # include <assuan.h> /* For _assuan_w32ce_finish_pipe. */
45 #endif
46
47 #include "util.h"
48
49 /* This object is used to register memory cleanup functions.
50    Technically they are not needed but they can avoid frequent
51    questions about un-released memory.  Note that we use the system
52    malloc and not any wrappers.  */
53 struct mem_cleanup_item_s;
54 typedef struct mem_cleanup_item_s *mem_cleanup_item_t;
55
56 struct mem_cleanup_item_s
57 {
58   mem_cleanup_item_t next;
59   void (*func) (void);
60 };
61
62 static mem_cleanup_item_t mem_cleanup_list;
63
64
65 /* The default error source of the application.  This is different
66    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
67    source file and thus is usable in code shared by applications.  */
68 gpg_err_source_t default_errsource;
69
70
71 #ifdef HAVE_W32CE_SYSTEM
72 static void parse_std_file_handles (int *argcp, char ***argvp);
73 static void
74 sleep_on_exit (void)
75 {
76   /* The sshd on CE swallows some of the command output.  Sleeping a
77      while usually helps.  */
78   Sleep (400);
79 }
80 #endif /*HAVE_W32CE_SYSTEM*/
81
82
83 static void
84 run_mem_cleanup (void)
85 {
86   mem_cleanup_item_t next;
87
88   while (mem_cleanup_list)
89     {
90       next = mem_cleanup_list->next;
91       mem_cleanup_list->func ();
92       free (mem_cleanup_list);
93       mem_cleanup_list = next;
94     }
95 }
96
97
98 void
99 register_mem_cleanup_func (void (*func)(void))
100 {
101   mem_cleanup_item_t item;
102
103   item = malloc (sizeof *item);
104   if (item)
105     {
106       item->func = func;
107       item->next = mem_cleanup_list;
108       mem_cleanup_list = item;
109     }
110 }
111
112
113 /* If STRING is not NULL write string to es_stdout or es_stderr.  MODE
114    must be 1 or 2.  If STRING is NULL flush the respective stream.  */
115 static int
116 writestring_via_estream (int mode, const char *string)
117 {
118   if (mode == 1 || mode == 2)
119     {
120       if (string)
121         return es_fputs (string, mode == 1? es_stdout : es_stderr);
122       else
123         return es_fflush (mode == 1? es_stdout : es_stderr);
124     }
125   else
126     return -1;
127 }
128
129
130 /* This function is to be used early at program startup to make sure
131    that some subsystems are initialized.  This is in particular
132    important for W32 to initialize the sockets so that our socket
133    emulation code used directly as well as in libassuan may be used.
134    It should best be called before any I/O is done so that setup
135    required for logging is ready.  ARGCP and ARGVP are the addresses
136    of the parameters given to main.  This function may modify them.
137
138    This function should be called only via the macro
139    init_common_subsystems.
140
141    CAUTION: This might be called while running suid(root).  */
142 void
143 _init_common_subsystems (gpg_err_source_t errsource, int *argcp, char ***argvp)
144 {
145   /* Store the error source in a gloabl variable. */
146   default_errsource = errsource;
147
148   atexit (run_mem_cleanup);
149
150   /* Try to auto set the character set.  */
151   set_native_charset (NULL);
152
153 #ifdef HAVE_W32_SYSTEM
154   /* For W32 we need to initialize the socket layer.  This is because
155      we use recv and send in libassuan as well as at some other
156      places.  If we are building with PTH we let pth_init do it.  We
157      can't do much on error so we ignore them.  An error would anyway
158      later pop up if one of the socket functions is used. */
159 # ifdef HAVE_NPTH
160   pth_init ();
161 # else
162   {
163     WSADATA wsadat;
164
165     WSAStartup (0x202, &wsadat);
166   }
167 # endif /*!HAVE_NPTH*/
168 #endif
169
170 #ifdef HAVE_W32CE_SYSTEM
171   /* Register the sleep exit function before the estream init so that
172      the sleep will be called after the estream registered atexit
173      function which flushes the left open estream streams and in
174      particular es_stdout.  */
175   atexit (sleep_on_exit);
176 #endif
177
178   /* Initialize the Estream library. */
179   es_init ();
180
181   /* Special hack for Windows CE: We extract some options from arg
182      to setup the standard handles.  */
183 #ifdef HAVE_W32CE_SYSTEM
184   parse_std_file_handles (argcp, argvp);
185 #else
186   (void)argcp;
187   (void)argvp;
188 #endif
189
190   /* Access the standard estreams as early as possible.  If we don't
191      do this the original stdio streams may have been closed when
192      _es_get_std_stream is first use and in turn it would connect to
193      the bit bucket.  */
194   {
195     int i;
196     for (i=0; i < 3; i++)
197       (void)_es_get_std_stream (i);
198   }
199
200   /* --version et al shall use estream as well.  */
201   argparse_register_outfnc (writestring_via_estream);
202 }
203
204
205
206 /* WindowsCE uses a very strange way of handling the standard streams.
207    There is a function SetStdioPath to associate a standard stream
208    with a file or a device but what we really want is to use pipes as
209    standard streams.  Despite that we implement pipes using a device,
210    we would have some limitations on the number of open pipes due to
211    the 3 character limit of device file name.  Thus we don't take this
212    path.  Another option would be to install a file system driver with
213    support for pipes; this would allow us to get rid of the device
214    name length limitation.  However, with GnuPG we can get away be
215    redefining the standard streams and passing the handles to be used
216    on the command line.  This has also the advantage that it makes
217    creating a process much easier and does not require the
218    SetStdioPath set and restore game.  The caller needs to pass the
219    rendezvous ids using up to three options:
220
221      -&S0=<rvid> -&S1=<rvid> -&S2=<rvid>
222
223    They are all optional but they must be the first arguments on the
224    command line.  Parsing stops as soon as an invalid option is found.
225    These rendezvous ids are then used to finish the pipe creation.*/
226 #ifdef HAVE_W32CE_SYSTEM
227 static void
228 parse_std_file_handles (int *argcp, char ***argvp)
229 {
230   int argc = *argcp;
231   char **argv = *argvp;
232   const char *s;
233   assuan_fd_t fd;
234   int i;
235   int fixup = 0;
236
237   if (!argc)
238     return;
239
240   for (argc--, argv++; argc; argc--, argv++)
241     {
242       s = *argv;
243       if (*s == '-' && s[1] == '&' && s[2] == 'S'
244           && (s[3] == '0' || s[3] == '1' || s[3] == '2')
245           && s[4] == '='
246           && (strchr ("-01234567890", s[5]) || !strcmp (s+5, "null")))
247         {
248           if (s[5] == 'n')
249             fd = ASSUAN_INVALID_FD;
250           else
251             fd = _assuan_w32ce_finish_pipe (atoi (s+5), s[3] != '0');
252           _es_set_std_fd (s[3] - '0', (int)fd);
253           fixup++;
254         }
255       else
256         break;
257     }
258
259   if (fixup)
260     {
261       argc = *argcp;
262       argc -= fixup;
263       *argcp = argc;
264
265       argv = *argvp;
266       for (i=1; i < argc; i++)
267         argv[i] = argv[i + fixup];
268       for (; i < argc + fixup; i++)
269         argv[i] = NULL;
270     }
271
272
273 }
274 #endif /*HAVE_W32CE_SYSTEM*/