2009-10-30 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / src / version.c
1 /* version.c - Version check routines.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008 g10 Code GmbH
4  
5    This file is part of GPGME.
6  
7    GPGME is free software; you can redistribute it and/or modify it
8    under the terms of the GNU Lesser General Public License as
9    published by the Free Software Foundation; either version 2.1 of
10    the License, or (at your option) any later version.
11    
12    GPGME is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16    
17    You should have received a copy of the GNU Lesser General Public
18    License along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #if HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <stdlib.h>
26 #include <string.h>
27 #include <limits.h>
28 #include <ctype.h>
29 #ifdef HAVE_W32_SYSTEM
30 #include <winsock2.h>
31 #endif
32
33 #include "gpgme.h"
34 #include "priv-io.h"
35 #include "debug.h"
36 #include "context.h"
37
38 /* For _gpgme_sema_subsystem_init ().  */
39 #include "sema.h"
40
41 #ifdef HAVE_ASSUAN_H
42 #include "assuan.h"
43 #endif
44
45 #ifdef HAVE_W32_SYSTEM
46 #include "windows.h"
47 #endif
48
49 /* We implement this function, so we have to disable the overriding
50    macro.  */
51 #undef gpgme_check_version
52
53 \f
54 /* Bootstrap the subsystems needed for concurrent operation.  This
55    must be done once at startup.  We can not guarantee this using a
56    lock, though, because the semaphore subsystem needs to be
57    initialized itself before it can be used.  So we expect that the
58    user performs the necessary synchronization.  */
59 static void
60 do_subsystem_inits (void)
61 {
62   static int done = 0;
63
64   if (done)
65     return;
66
67 #ifdef HAVE_W32_SYSTEM
68       {
69         WSADATA wsadat;
70         
71         WSAStartup (0x202, &wsadat);
72       }
73 #endif
74
75   _gpgme_sema_subsystem_init ();
76 #ifdef HAVE_ASSUAN_H
77   assuan_set_assuan_err_source (GPG_ERR_SOURCE_GPGME);
78 #endif /*HAVE_ASSUAN_H*/
79   _gpgme_debug_subsystem_init ();
80   _gpgme_io_subsystem_init ();
81 #if defined(HAVE_W32_SYSTEM) && defined(HAVE_ASSUAN_H)
82   /* We need to make sure that the sockets are initialized.  */
83   {
84     WSADATA wsadat;
85     
86     WSAStartup (0x202, &wsadat);
87   }
88 #endif /*HAVE_W32_SYSTEM && HAVE_ASSUAN_H*/
89
90   done = 1;
91 }
92
93
94 /* Read the next number in the version string STR and return it in
95    *NUMBER.  Return a pointer to the tail of STR after parsing, or
96    *NULL if the version string was invalid.  */
97 static const char *
98 parse_version_number (const char *str, int *number)
99 {
100 #define MAXVAL ((INT_MAX - 10) / 10)
101   int val = 0;
102
103   /* Leading zeros are not allowed.  */
104   if (*str == '0' && isdigit(str[1]))
105     return NULL;
106
107   while (isdigit (*str) && val <= MAXVAL)
108     {
109       val *= 10;
110       val += *(str++) - '0';
111     }
112   *number = val;
113   return val > MAXVAL ? NULL : str;
114 }
115
116
117 /* Parse the version string STR in the format MAJOR.MINOR.MICRO (for
118    example, 9.3.2) and return the components in MAJOR, MINOR and MICRO
119    as integers.  The function returns the tail of the string that
120    follows the version number.  This might be te empty string if there
121    is nothing following the version number, or a patchlevel.  The
122    function returns NULL if the version string is not valid.  */
123 static const char *
124 parse_version_string (const char *str, int *major, int *minor, int *micro)
125 {
126   str = parse_version_number (str, major);
127   if (!str || *str != '.')
128     return NULL;
129   str++;
130
131   str = parse_version_number (str, minor);
132   if (!str || *str != '.')
133     return NULL;
134   str++;
135
136   str = parse_version_number (str, micro);
137   if (!str)
138     return NULL;
139
140   /* A patchlevel might follow.  */
141   return str;
142 }
143
144
145 /* Return true if MY_VERSION is at least REQ_VERSION, and false
146    otherwise.  */
147 int
148 _gpgme_compare_versions (const char *my_version,
149                          const char *rq_version)
150 {
151   int my_major, my_minor, my_micro;
152   int rq_major, rq_minor, rq_micro;
153   const char *my_plvl, *rq_plvl;
154
155   if (!rq_version)
156     return 1;
157   if (!my_version)
158     return 0;
159
160   my_plvl = parse_version_string (my_version, &my_major, &my_minor, &my_micro);
161   if (!my_plvl)
162     return 0;
163
164   rq_plvl = parse_version_string (rq_version, &rq_major, &rq_minor, &rq_micro);
165   if (!rq_plvl)
166     return 0;
167
168   if (my_major > rq_major
169       || (my_major == rq_major && my_minor > rq_minor)
170       || (my_major == rq_major && my_minor == rq_minor 
171           && my_micro > rq_micro)
172       || (my_major == rq_major && my_minor == rq_minor
173           && my_micro == rq_micro && strcmp (my_plvl, rq_plvl) >= 0))
174     return 1;
175
176   return 0;
177 }
178
179
180 /* Check that the the version of the library is at minimum the
181    requested one and return the version string; return NULL if the
182    condition is not met.  If a NULL is passed to this function, no
183    check is done and the version string is simply returned.
184
185    This function must be run once at startup, as it also initializes
186    some subsystems.  Its invocation must be synchronized against
187    calling any of the other functions in a multi-threaded
188    environments.  */
189 const char *
190 gpgme_check_version (const char *req_version)
191 {
192   char *result;
193   do_subsystem_inits ();
194
195   /* Catch-22: We need to get at least the debug subsystem ready
196      before using the trace facility.  If we won't the trace would
197      automagically initialize the debug system with out the locks
198      being initialized and missing the assuan log level setting. */
199   TRACE2 (DEBUG_INIT, "gpgme_check_version: ", 0,
200           "req_version=%s, VERSION=%s",
201           req_version? req_version:"(null)", VERSION);
202  
203   result = _gpgme_compare_versions (VERSION, req_version) ? VERSION : NULL;
204   if (result != NULL)
205     _gpgme_selftest = 0;
206
207   return result;
208 }
209
210 /* Check the version and also at runtime if the struct layout of the
211    library matches the one of the user.  This is particular useful for
212    Windows targets (-mms-bitfields).  */
213 const char *
214 gpgme_check_version_internal (const char *req_version,
215                               size_t offset_sig_validity)
216 {
217   const char *result;
218
219   result = gpgme_check_version (req_version);
220   if (result == NULL)
221     return result;
222
223   /* Catch-22, see above.  */
224   TRACE2 (DEBUG_INIT, "gpgme_check_version_internal: ", 0,
225           "req_version=%s, offset_sig_validity=%i",
226           req_version ? req_version : "(null)", offset_sig_validity);
227
228   if (offset_sig_validity != offsetof (struct _gpgme_signature, validity))
229     {
230       TRACE1 (DEBUG_INIT, "gpgme_check_version_internal: ", 0,
231               "offset_sig_validity mismatch: expected %i",
232               offsetof (struct _gpgme_signature, validity));
233       _gpgme_selftest = GPG_ERR_SELFTEST_FAILED;
234     }
235
236   return result;
237 }
238
239 \f
240 #define LINELENGTH 80
241
242 /* Extract the version string of a program from STRING.  The version
243    number is expected to be in GNU style format:
244    
245      foo 1.2.3
246      foo (bar system) 1.2.3
247      foo 1.2.3 cruft
248      foo (bar system) 1.2.3 cruft.
249
250   Spaces and tabs are skipped and used as delimiters, a term in
251   (nested) parenthesis before the version string is skipped, the
252   version string may consist of any non-space and non-tab characters
253   but needs to bstart with a digit.
254 */
255 static const char *
256 extract_version_string (const char *string, size_t *r_len)
257 {
258   const char *s;
259   int count, len;
260
261   for (s=string; *s; s++)
262     if (*s == ' ' || *s == '\t')
263         break;
264   while (*s == ' ' || *s == '\t')
265     s++;
266   if (*s == '(')
267     {
268       for (count=1, s++; count && *s; s++)
269         if (*s == '(')
270           count++;
271         else if (*s == ')')
272           count--;
273     }
274   /* For robustness we look for a digit.  */
275   while ( *s && !(*s >= '0' && *s <= '9') )
276     s++;
277   if (*s >= '0' && *s <= '9')
278     {
279       for (len=0; s[len]; len++)
280         if (s[len] == ' ' || s[len] == '\t')
281           break;
282     }
283   else
284     len = 0;
285
286   *r_len = len;
287   return s;
288 }
289
290
291 /* Retrieve the version number from the --version output of the
292    program FILE_NAME.  */
293 char *
294 _gpgme_get_program_version (const char *const file_name)
295 {
296   char line[LINELENGTH] = "";
297   int linelen = 0;
298   char *mark = NULL;
299   int rp[2];
300   int nread;
301   char *argv[] = {NULL /* file_name */, "--version", 0};
302   struct spawn_fd_item_s cfd[] = { {-1, 1 /* STDOUT_FILENO */, -1, 0},
303                                    {-1, -1} };
304   int status;
305
306   if (!file_name)
307     return NULL;
308   argv[0] = (char *) file_name;
309
310   if (_gpgme_io_pipe (rp, 1) < 0)
311     return NULL;
312
313   cfd[0].fd = rp[1];
314
315   status = _gpgme_io_spawn (file_name, argv, 0, cfd, NULL);
316   if (status < 0)
317     {
318       _gpgme_io_close (rp[0]);
319       _gpgme_io_close (rp[1]);
320       return NULL;
321     }
322
323   do
324     {
325       nread = _gpgme_io_read (rp[0], &line[linelen], LINELENGTH - linelen - 1);
326       if (nread > 0)
327         {
328           line[linelen + nread] = '\0';
329           mark = strchr (&line[linelen], '\n');
330           if (mark)
331             {
332               if (mark > &line[0] && *mark == '\r')
333                 mark--;
334               *mark = '\0';
335               break;
336             }
337           linelen += nread;
338         }
339     }
340   while (nread > 0 && linelen < LINELENGTH - 1);
341
342   _gpgme_io_close (rp[0]);
343
344   if (mark)
345     {
346       size_t len;
347       const char *s;
348
349       s = extract_version_string (line, &len);
350       if (!len)
351         return NULL;
352       mark = malloc (len + 1);
353       if (!mark)
354         return NULL;
355       memcpy (mark, s, len);
356       mark[len] = 0;
357       return mark;
358     }
359
360   return NULL;
361 }