Okay, it runs at least on Windows 95
[gpgme.git] / gpgme / data.c
1 /* data.c
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME 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  * GPGME 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 <stdio.h>
23 #include <stdlib.h>
24 #include <assert.h>
25 #include <errno.h>
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <unistd.h>
29
30
31 #include "util.h"
32 #include "context.h"
33 #include "ops.h"
34
35 #define ALLOC_CHUNK 1024
36 #define my_isdigit(a)  ( (a) >='0' && (a) <= '9' )
37 #define my_isxdigit(a) ( my_isdigit((a))               \
38                          || ((a) >= 'A' && (a) <= 'F') \
39                          || ((a) >= 'f' && (a) <= 'f') )
40
41
42 /**
43  * gpgme_data_new:
44  * @r_dh: returns the new data object 
45  * 
46  * Create a new data object without any content. 
47  * 
48  * Return value: An error value or 0 on success
49  **/
50 GpgmeError
51 gpgme_data_new ( GpgmeData *r_dh )
52 {
53     GpgmeData dh;
54
55     if (!r_dh)
56         return mk_error (Invalid_Value);
57     *r_dh = NULL;
58     dh = xtrycalloc ( 1, sizeof *dh );
59     if (!dh)
60         return mk_error (Out_Of_Core);
61     dh->mode = GPGME_DATA_MODE_INOUT; 
62     *r_dh = dh;
63     return 0;
64 }
65
66
67 /**
68  * gpgme_data_new_from_mem:
69  * @r_dh:   Returns a new data object.
70  * @buffer: Initialize with this.
71  * @size: Size of the buffer
72  * @copy: Flag wether a copy of the buffer should be used.
73  * 
74  * Create a new data object and initialize with data
75  * from the memory.  A @copy with value %TRUE creates a copy of the
76  * memory, a value of %FALSE uses the original memory of @buffer and the
77  * caller has to make sure that this buffer is valid until gpgme_release_data()
78  * is called.
79  * 
80  * Return value: 
81  **/
82 GpgmeError
83 gpgme_data_new_from_mem ( GpgmeData *r_dh,
84                           const char *buffer, size_t size, int copy )
85 {
86     GpgmeData dh;
87     GpgmeError err;
88
89     if (!r_dh || !buffer)
90         return mk_error (Invalid_Value);
91     *r_dh = NULL;
92     err = gpgme_data_new ( &dh );
93     if (err)
94         return err;
95     dh->len  = size;
96     if (copy) {
97         dh->private_buffer = xtrymalloc ( size );
98         if ( !dh->private_buffer ) {
99             gpgme_data_release (dh);
100             return mk_error (Out_Of_Core);
101         }
102         dh->private_len = size;
103         memcpy (dh->private_buffer, buffer, size );
104         dh->data = dh->private_buffer;
105         dh->writepos = size;
106     }
107     else {
108         dh->data = buffer;
109     }
110     dh->type = GPGME_DATA_TYPE_MEM;
111     
112     *r_dh = dh;
113     return 0;
114 }
115
116
117 GpgmeError
118 gpgme_data_new_with_read_cb ( GpgmeData *r_dh,
119                               int (*read_cb)(void*,char *,size_t,size_t*),
120                               void *read_cb_value )
121 {
122     GpgmeData dh;
123     GpgmeError err;
124
125     if (!r_dh || !read_cb)
126         return mk_error (Invalid_Value);
127     *r_dh = NULL;
128     err = gpgme_data_new ( &dh );
129     if (err)
130         return err;
131     dh->type = GPGME_DATA_TYPE_CB;
132     dh->mode = GPGME_DATA_MODE_OUT;
133     dh->read_cb = read_cb;
134     dh->read_cb_value = read_cb_value;
135     
136     *r_dh = dh;
137     return 0;
138 }
139
140 /**
141  * gpgme_data_new_from_file:
142  * @r_dh: returns the new data object
143  * @fname: filename
144  * @copy: Flag, whether the file should be copied.
145  * 
146  * Create a new data object and initialize it with the content of 
147  * the file @file.  If @copy is %True the file is immediately read in
148  * adn closed.  @copy of %False is not yet supportted.
149  * 
150  * Return value: An error code or 0 on success. If the error code is
151  * %GPGME_File_Error, the OS error code is held in %errno.
152  **/
153 GpgmeError
154 gpgme_data_new_from_file ( GpgmeData *r_dh, const char *fname, int copy )
155 {
156     GpgmeData dh;
157     GpgmeError err;
158     struct stat st;
159     FILE *fp;
160
161     if (!r_dh)
162         return mk_error (Invalid_Value);
163     *r_dh = NULL;
164     /* We only support copy for now - in future we might want to honor the 
165      * copy flag and just store a file pointer */
166     if (!copy)
167         return mk_error (Not_Implemented);
168     if (!fname)
169         return mk_error (Invalid_Value);
170
171     err = gpgme_data_new ( &dh );
172     if (err)
173         return err;
174
175     fp = fopen (fname, "rb");
176     if (!fp) {
177         int save_errno = errno;
178         gpgme_data_release (dh);
179         errno = save_errno;
180         return mk_error (File_Error);
181     }
182
183     if( fstat(fileno(fp), &st) ) {
184         int save_errno = errno;
185         fclose (fp);
186         gpgme_data_release (dh);
187         errno = save_errno;
188         return mk_error (File_Error);
189     }
190
191     /* We should check the length of the file and don't allow for to
192      * large files */
193     dh->private_buffer = xtrymalloc ( st.st_size );
194     if ( !dh->private_buffer ) {
195         fclose (fp);
196         gpgme_data_release (dh);
197         return mk_error (Out_Of_Core);
198     }
199     dh->private_len = st.st_size;
200
201     if ( fread ( dh->private_buffer, dh->private_len, 1, fp ) != 1 ) {
202         int save_errno = errno;
203         fclose (fp);
204         gpgme_data_release (dh);
205         errno = save_errno;
206         return mk_error (File_Error);
207     }
208
209     fclose (fp);
210
211     dh->len = dh->private_len;
212     dh->data = dh->private_buffer;
213     dh->writepos = dh->len;
214     dh->type = GPGME_DATA_TYPE_MEM;
215     
216     *r_dh = dh;
217     return 0;
218 }
219
220
221
222 /**
223  * gpgme_data_release:
224  * @dh: Data object 
225  * 
226  * Release the data object @dh.  @dh may be NULL in which case nothing
227  * happens.
228  **/
229 void
230 gpgme_data_release ( GpgmeData dh )
231 {
232     if (dh) {
233         xfree (dh->private_buffer); 
234         xfree (dh);
235     }
236 }
237
238 char *
239 _gpgme_data_release_and_return_string ( GpgmeData dh )
240 {
241     char *val = NULL;
242
243     if (dh) {
244         if ( _gpgme_data_append ( dh, "", 0 ) ) /* append EOS */
245             xfree (dh->private_buffer );
246         else {
247             val = dh->private_buffer;
248             if ( !val && dh->data ) {
249                 val = xtrymalloc ( dh->len );
250                 if ( val )
251                     memcpy ( val, dh->data, dh->len );
252             }
253         }
254         xfree (dh);
255     }
256     return val;
257 }
258
259 /**
260  * gpgme_data_release_and_get_mem:
261  * @dh: the data object
262  * @r_len: returns the length of the memory
263  * 
264  * Release the data object @dh and return its content and the length of
265  * that content.  The caller has to free this data.  @dh maybe NULL in
266  * which case NULL is returned.  I there is not enough memory for allocating
267  * the return value, NULL is returned and the object is released.
268  * 
269  * Return value: a pointer to an allocated buffer of length @r_len.
270  **/
271 char *
272 gpgme_data_release_and_get_mem ( GpgmeData dh, size_t *r_len )
273 {
274     char *val = NULL;
275
276     if (r_len)
277         *r_len = 0;
278     if (dh) {
279         size_t len = dh->len;
280         val = dh->private_buffer;
281         if ( !val && dh->data ) {
282             val = xtrymalloc ( len );
283             if ( val )
284                 memcpy ( val, dh->data, len );
285         }
286         xfree (dh);
287         if (val && r_len )
288             *r_len = len;
289     }
290     return val;
291 }
292
293
294 /**
295  * gpgme_data_get_type:
296  * @dh: the data object
297  * 
298  * Get the type of the data object.
299  * Data types are prefixed with %GPGME_DATA_TYPE_
300  * 
301  * Return value: the data type
302  **/
303 GpgmeDataType
304 gpgme_data_get_type ( GpgmeData dh )
305 {
306     if ( !dh || (!dh->data && !dh->read_cb))
307         return GPGME_DATA_TYPE_NONE;
308             
309     return dh->type;
310 }
311
312 void 
313 _gpgme_data_set_mode ( GpgmeData dh, GpgmeDataMode mode )
314 {
315     assert (dh);
316     dh->mode = mode;
317 }
318
319
320 GpgmeDataMode
321 _gpgme_data_get_mode ( GpgmeData dh )
322 {
323     assert (dh);
324     return dh->mode;
325 }
326
327 /**
328  * gpgme_data_rewind:
329  * @dh: the data object 
330  * 
331  * Prepare the data object in a way, that a gpgme_data_read() does start
332  * at the beginning of the data.  This has to be done for all types
333  * of data objects.
334  * 
335  * Return value: An error code or 0 on success
336  **/
337 GpgmeError
338 gpgme_data_rewind ( GpgmeData dh )
339 {
340     if ( !dh )
341         return mk_error (Invalid_Value);
342
343     if (dh->type == GPGME_DATA_TYPE_MEM ) {
344         dh->readpos = 0;
345     }
346     else if (dh->type == GPGME_DATA_TYPE_CB) {
347         dh->len = dh->readpos = 0;
348         dh->read_cb_eof = 0;
349         /* FIXME: do a special call to the read function to trigger a rewind
350            there */
351     }
352     else
353         return mk_error (General_Error);
354     return 0;
355 }
356
357 /**
358  * gpgme_data_read:
359  * @dh: the data object
360  * @buffer: A buffer 
361  * @length: The length of that bufer
362  * @nread: Returns the number of bytes actually read.
363  * 
364  * Copy data from the current read position (which may be set by
365  * gpgme_data_rewind()) to the supplied @buffer, max. @length bytes
366  * are copied and the actual number of bytes are returned in @nread.
367  * If there are no more bytes available %GPGME_EOF is returned and @nread
368  * is set to 0.
369  * 
370  * Return value: An errorcode or 0 on success, EOF is indcated by the
371  * error code GPGME_EOF.
372  **/
373 GpgmeError
374 gpgme_data_read ( GpgmeData dh, char *buffer, size_t length, size_t *nread )
375 {
376     size_t nbytes;
377
378     if ( !dh )
379         return mk_error (Invalid_Value);
380     if (dh->type == GPGME_DATA_TYPE_MEM ) {
381         nbytes = dh->len - dh->readpos;
382         if ( !nbytes ) {
383             *nread = 0;
384             return mk_error(EOF);
385         }
386         if (nbytes > length)
387             nbytes = length;
388         memcpy ( buffer, dh->data + dh->readpos, nbytes );
389         *nread = nbytes;
390         dh->readpos += nbytes;
391     }
392     else if (dh->type == GPGME_DATA_TYPE_CB) {
393         nbytes = dh->len - dh->readpos;
394         if ( nbytes ) {
395             /* we have unread data - return this */
396             if (nbytes > length)
397                 nbytes = length;
398             memcpy ( buffer, dh->data + dh->readpos, nbytes );
399             *nread = nbytes;
400             dh->readpos += nbytes;
401         }
402         else { /* get the data from the callback */
403             if (!dh->read_cb || dh->read_cb_eof) { 
404                 *nread = 0;
405                 return mk_error (EOF);
406             }
407             if (dh->read_cb (dh->read_cb_value, buffer, length, nread )) {
408                 *nread = 0;
409                 dh->read_cb_eof = 1;
410                 return mk_error (EOF);
411             }
412         }
413     }
414     else
415         return mk_error (General_Error);
416     return 0;
417
418
419 GpgmeError
420 _gpgme_data_unread (GpgmeData dh, const char *buffer, size_t length )
421 {
422    if ( !dh )
423         return mk_error (Invalid_Value);
424
425    if (dh->type == GPGME_DATA_TYPE_MEM ) {
426        /* check that we don't unread more than we have yet read */
427        if ( dh->readpos < length )
428            return mk_error (Invalid_Value);
429        /* No need to use the buffer for this data type */
430        dh->readpos -= length;
431    }
432    else {
433        return mk_error (General_Error);
434    }
435
436    return 0;
437 }
438
439
440 /* 
441  * This function does make sense when we know that it contains no nil chars.
442  */
443 char *
444 _gpgme_data_get_as_string ( GpgmeData dh )
445 {
446     char *val = NULL;
447
448     if (dh) {
449         val = xtrymalloc ( dh->len+1 );
450         if ( val ) {
451             memcpy ( val, dh->data, dh->len );
452             val[dh->len] = 0;
453         }
454     }
455     return val;
456 }
457
458
459
460 GpgmeError
461 _gpgme_data_append ( GpgmeData dh, const char *buffer, size_t length )
462 {
463     assert (dh);
464
465     if ( dh->type == GPGME_DATA_TYPE_NONE ) {
466         /* convert it to a mem data type */
467         assert (!dh->private_buffer);
468         dh->type = GPGME_DATA_TYPE_MEM;
469         dh->private_len = length < ALLOC_CHUNK? ALLOC_CHUNK : length;
470         dh->private_buffer = xtrymalloc ( dh->private_len );
471         if (!dh->private_buffer) {
472             dh->private_len = 0;
473             return mk_error (Out_Of_Core);
474         }
475         dh->writepos = 0;
476         dh->data = dh->private_buffer;
477     }
478     else if ( dh->type != GPGME_DATA_TYPE_MEM ) 
479         return mk_error (Invalid_Type);
480     
481     if ( dh->mode != GPGME_DATA_MODE_INOUT 
482          && dh->mode != GPGME_DATA_MODE_IN  )
483         return mk_error (Invalid_Mode);
484
485     if ( !dh->private_buffer ) {
486         /* we have to copy it now */
487         assert (dh->data);
488         dh->private_len = dh->len+length;
489         if (dh->private_len < ALLOC_CHUNK)
490             dh->private_len = ALLOC_CHUNK;
491         dh->private_buffer = xtrymalloc ( dh->private_len );
492         if (!dh->private_buffer) {
493             dh->private_len = 0;
494             return mk_error (Out_Of_Core);
495         }
496         memcpy ( dh->private_buffer, dh->data, dh->len );
497         dh->writepos = dh->len;
498         dh->data = dh->private_buffer;
499     }
500
501     /* allocate more memory if needed */
502     if ( dh->writepos + length > dh->private_len ) {
503         char *p;
504         size_t newlen = dh->private_len
505                         + (dh->len < ALLOC_CHUNK? ALLOC_CHUNK : length);
506         p = xtryrealloc ( dh->private_buffer, newlen );
507         if ( !p ) 
508             return mk_error (Out_Of_Core);
509         dh->private_buffer = p;
510         dh->private_len = newlen;
511         dh->data = dh->private_buffer;
512         assert ( !(dh->writepos + length > dh->private_len) );      
513     }
514
515     memcpy ( dh->private_buffer + dh->writepos, buffer, length );
516     dh->writepos += length;
517     dh->len += length;
518
519     return 0;
520 }
521
522 GpgmeError
523 _gpgme_data_append_string ( GpgmeData dh, const char *s )
524 {
525     return _gpgme_data_append ( dh, s, s? strlen(s):0 );
526 }
527
528
529 GpgmeError
530 _gpgme_data_append_for_xml ( GpgmeData dh,
531                              const char *buffer, size_t len )
532 {
533     const char *text, *s;
534     size_t n;
535     int rc = 0; 
536        
537     if ( !dh || !buffer )
538         return mk_error (Invalid_Value);
539
540     do {
541         for (text=NULL, s=buffer, n=len; n && !text; s++, n-- ) {
542             if ( *s == '<' ) 
543                 text = "&lt;";
544             else if ( *s == '>' ) 
545                 text = "&gt;";  /* not sure whether this is really needed */
546             else if ( *s == '&' ) 
547                 text = "&amp;";
548             else if ( !*s )
549                 text = "&#00;";
550         }
551         if (text) {
552             s--; n++;
553         }
554         if (s != buffer) 
555             rc = _gpgme_data_append ( dh, buffer, s-buffer );
556         if ( !rc && text) {
557             rc = _gpgme_data_append_string ( dh, text );
558             s++; n--;
559         }
560         buffer = s;
561         len = n;
562     } while ( !rc && len );
563     return rc;
564 }
565
566
567 /*
568  * Append a string to DATA and convert it so that the result will be 
569  * valid XML. 
570  */
571 GpgmeError
572 _gpgme_data_append_string_for_xml ( GpgmeData dh, const char *string )
573 {
574     return _gpgme_data_append_for_xml ( dh, string, strlen (string) );
575 }
576
577
578 static int
579 hextobyte( const byte *s )
580 {
581     int c;
582
583     if( *s >= '0' && *s <= '9' )
584         c = 16 * (*s - '0');
585     else if( *s >= 'A' && *s <= 'F' )
586         c = 16 * (10 + *s - 'A');
587     else if( *s >= 'a' && *s <= 'f' )
588         c = 16 * (10 + *s - 'a');
589     else
590         return -1;
591     s++;
592     if( *s >= '0' && *s <= '9' )
593         c += *s - '0';
594     else if( *s >= 'A' && *s <= 'F' )
595         c += 10 + *s - 'A';
596     else if( *s >= 'a' && *s <= 'f' )
597         c += 10 + *s - 'a';
598     else
599         return -1;
600     return c;
601 }
602
603
604
605
606 /* 
607  * Append a string with percent style (%XX) escape characters as XML
608  */
609 GpgmeError
610 _gpgme_data_append_percentstring_for_xml ( GpgmeData dh, const char *string )
611 {
612     const byte *s;
613     byte *buf, *d;
614     int val;
615     GpgmeError err;
616
617     d = buf = xtrymalloc ( strlen (string) );
618     for (s=string; *s; s++ ) {
619         if ( *s == '%' && (val=hextobyte (s+1)) != -1 ) {
620             *d++ = val;
621             s += 2;
622         }
623         else
624             *d++ = *s;
625     }
626
627     err = _gpgme_data_append_for_xml ( dh, buf, d - buf );
628     xfree (buf);
629     return err;
630 }
631
632
633
634
635
636
637