See ChangeLog: Mon Jan 24 13:04:28 CET 2000 Werner Koch
[gnupg.git] / util / miscutil.c
1 /* miscutil.c -  miscellaneous utilities
2  *      Copyright (C) 1998, 1999 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <time.h>
26 #include <ctype.h>
27 #ifdef HAVE_LANGINFO_H
28   #include <langinfo.h>
29 #endif
30 #include "types.h"
31 #include "util.h"
32 #include "i18n.h"
33
34 /****************
35  * I know that the OpenPGP protocol has a Y2106 problem ;-)
36  */
37 u32
38 make_timestamp()
39 {
40     return time(NULL);
41 }
42
43 /****************
44  * Scan a date string and return a timestamp.
45  * The only supported format is "yyyy-mm-dd"
46  * Returns 0 for an invalid date.
47  */
48 u32
49 scan_isodatestr( const char *string )
50 {
51     int year, month, day;
52     struct tm tmbuf;
53     time_t stamp;
54     int i;
55
56     if( strlen(string) != 10 || string[4] != '-' || string[7] != '-' )
57         return 0;
58     for( i=0; i < 4; i++ )
59         if( !isdigit(string[i]) )
60             return 0;
61     if( !isdigit(string[5]) || !isdigit(string[6]) )
62         return 0;
63     if( !isdigit(string[8]) || !isdigit(string[9]) )
64         return 0;
65     year = atoi(string);
66     month = atoi(string+5);
67     day = atoi(string+8);
68     /* some basic checks */
69     if( year < 1970 || month < 1 || month > 12 || day < 1 || day > 31 )
70         return 0;
71     memset( &tmbuf, 0, sizeof tmbuf );
72     tmbuf.tm_mday = day;
73     tmbuf.tm_mon = month-1;
74     tmbuf.tm_year = year - 1900;
75     tmbuf.tm_isdst = -1;
76     stamp = mktime( &tmbuf );
77     if( stamp == (time_t)-1 )
78         return 0;
79     return stamp;
80 }
81
82
83 u32
84 add_days_to_timestamp( u32 stamp, u16 days )
85 {
86     return stamp + days*86400L;
87 }
88
89
90 /****************
91  * Return a string with a time value in the form: x Y, n D, n H
92  */
93
94 const char *
95 strtimevalue( u32 value )
96 {
97     static char buffer[30];
98     unsigned int years, days, hours, minutes;
99
100     value /= 60;
101     minutes = value % 60;
102     value /= 60;
103     hours = value % 24;
104     value /= 24;
105     days = value % 365;
106     value /= 365;
107     years = value;
108
109     sprintf(buffer,"%uy%ud%uh%um", years, days, hours, minutes );
110     if( years )
111         return buffer;
112     if( days )
113         return strchr( buffer, 'y' ) + 1;
114     return strchr( buffer, 'd' ) + 1;
115 }
116
117
118 /****************
119  * Note: this function returns GMT
120  */
121 const char *
122 strtimestamp( u32 stamp )
123 {
124     static char buffer[11+5];
125     struct tm *tp;
126     time_t atime = stamp;
127
128     tp = gmtime( &atime );
129     sprintf(buffer,"%04d-%02d-%02d",
130                     1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
131     return buffer;
132 }
133
134 /****************
135  * Note: this function returns local time
136  */
137 const char *
138 asctimestamp( u32 stamp )
139 {
140     static char buffer[50];
141     #if defined (HAVE_STRFTIME) && defined (HAVE_NL_LANGINFO)
142       static char fmt[50];
143     #endif
144     struct tm *tp;
145     time_t atime = stamp;
146
147     tp = localtime( &atime );
148   #ifdef HAVE_STRFTIME
149     #if defined(HAVE_NL_LANGINFO)
150       mem2str( fmt, nl_langinfo(D_T_FMT), DIM(fmt) );
151       if( strstr( fmt, "%Z" ) == NULL )
152         strcat( fmt, " %Z");
153       strftime( buffer, DIM(buffer)-1, fmt, tp );
154     #else
155       /* fixme: we should check whether the locale appends a " %Z"
156        * These locales from glibc don't put the " %Z":
157        * fi_FI hr_HR ja_JP lt_LT lv_LV POSIX ru_RU ru_SU sv_FI sv_SE zh_CN
158        */
159       strftime( buffer, DIM(buffer)-1, "%c %Z", tp );
160     #endif
161     buffer[DIM(buffer)-1] = 0;
162   #else
163     mem2str( buffer, asctime(tp), DIM(buffer) );
164   #endif
165     return buffer;
166 }
167
168 /****************
169  * Print a string to FP, but filter all control characters out.
170  */
171 void
172 print_string( FILE *fp, const byte *p, size_t n, int delim )
173 {
174     for( ; n; n--, p++ )
175         if( iscntrl( *p ) || *p == delim ) {
176             putc('\\', fp);
177             if( *p == '\n' )
178                 putc('n', fp);
179             else if( *p == '\r' )
180                 putc('r', fp);
181             else if( *p == '\f' )
182                 putc('f', fp);
183             else if( *p == '\v' )
184                 putc('v', fp);
185             else if( *p == '\b' )
186                 putc('b', fp);
187             else if( !*p )
188                 putc('0', fp);
189             else
190                 fprintf(fp, "x%02x", *p );
191         }
192         else
193             putc(*p, fp);
194 }
195
196 /****************
197  * Print an UTF8 string to FP and filter all control characters out.
198  */
199 void
200 print_utf8_string( FILE *fp, const byte *p, size_t n )
201 {
202     size_t i;
203     char *buf;
204
205     /* we can handle plain ascii simpler, so check for it first */
206     for(i=0; i < n; i++ ) {
207         if( p[i] & 0x80 )
208             break;
209     }
210     if( i < n ) {
211         buf = utf8_to_native( p, n );
212         fputs( buf, fp );
213         gcry_free( buf );
214     }
215     else
216         print_string( fp, p, n, 0 );
217 }
218
219 /****************
220  * This function returns a string which is suitable for printing
221  * Caller must release it with gcry_free()
222  */
223 char *
224 make_printable_string( const byte *p, size_t n, int delim )
225 {
226     size_t save_n, buflen;
227     const byte *save_p;
228     char *buffer, *d;
229
230     /* first count length */
231     for(save_n = n, save_p = p, buflen=1 ; n; n--, p++ ) {
232         if( iscntrl( *p ) || *p == delim ) {
233             if( *p=='\n' || *p=='\r' || *p=='\f'
234                 || *p=='\v' || *p=='\b' || !*p )
235                 buflen += 2;
236             else
237                 buflen += 4;
238         }
239         else
240             buflen++;
241     }
242     p = save_p;
243     n = save_n;
244     /* and now make the string */
245     d = buffer = gcry_xmalloc( buflen );
246     for( ; n; n--, p++ ) {
247         if( iscntrl( *p ) || *p == delim ) {
248             *d++ = '\\';
249             if( *p == '\n' )
250                 *d++ = 'n';
251             else if( *p == '\r' )
252                 *d++ = 'r';
253             else if( *p == '\f' )
254                 *d++ = 'f';
255             else if( *p == '\v' )
256                 *d++ = 'v';
257             else if( *p == '\b' )
258                 *d++ = 'b';
259             else if( !*p )
260                 *d++ = '0';
261             else {
262                 sprintf(d, "x%02x", *p );
263                 d += 2;
264             }
265         }
266         else
267             *d++ = *p;
268     }
269     *d = 0;
270     return buffer;
271 }
272
273
274 int
275 answer_is_yes( const char *s )
276 {
277     char *long_yes = _("yes");
278     char *short_yes = _("yY");
279     char *long_no = _("no");
280     char *short_no = _("nN");
281
282     if( !stricmp(s, long_yes ) )
283         return 1;
284     if( strchr( short_yes, *s ) && !s[1] )
285         return 1;
286     /* test for no strings to catch ambiguities for the next test */
287     if( !stricmp(s, long_no ) )
288         return 0;
289     if( strchr( short_no, *s ) && !s[1] )
290         return 0;
291     /* test for the english version (for those who are used to type yes) */
292     if( !stricmp(s, "yes" ) )
293         return 1;
294     if( strchr( "yY", *s ) && !s[1] )
295         return 1;
296     return 0;
297 }
298
299
300 /****************
301  * Return 1 for yes, -1 for quit, or 0 for no
302  */
303 int
304 answer_is_yes_no_quit( const char *s )
305 {
306     char *long_yes = _("yes");
307     char *long_no = _("no");
308     char *long_quit = _("quit");
309     char *short_yes = _("yY");
310     char *short_no = _("nN");
311     char *short_quit = _("qQ");
312
313     if( !stricmp(s, long_yes ) )
314         return 1;
315     if( !stricmp(s, long_no ) )
316         return 0;
317     if( !stricmp(s, long_quit ) )
318         return -1;
319     if( strchr( short_yes, *s ) && !s[1] )
320         return 1;
321     if( strchr( short_no, *s ) && !s[1] )
322         return 0;
323     if( strchr( short_quit, *s ) && !s[1] )
324         return -1;
325     if( !stricmp(s, "yes" ) )
326         return 1;
327     if( !stricmp(s, "quit" ) )
328         return -1;
329     if( strchr( "yY", *s ) && !s[1] )
330         return 1;
331     if( strchr( "qQ", *s ) && !s[1] )
332         return -1;
333     return 0;
334 }
335
336