Add progress CB and subkey listing
[gpgme.git] / gpgme / gpgme.c
1 /* gpgme.c -  GnuPG Made Easy
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
26 #include "util.h"
27 #include "context.h"
28 #include "ops.h"
29
30 #define my_isdigit(a)  ( (a) >='0' && (a) <= '9' )
31 #define my_isxdigit(a) ( my_isdigit((a))               \
32                          || ((a) >= 'A' && (a) <= 'F') \
33                          || ((a) >= 'f' && (a) <= 'f') )
34
35 /**
36  * gpgme_new:
37  * @r_ctx: Returns the new context
38  * 
39  * Create a new context to be used with most of the other GPGME
40  * functions.  Use gpgme_release_contect() to release all resources
41  *
42  * Return value: An error code 
43  **/
44 GpgmeError
45 gpgme_new (GpgmeCtx *r_ctx)
46 {
47     GpgmeCtx c;
48
49     c = xtrycalloc ( 1, sizeof *c );
50     if (!c)
51         return mk_error (Out_Of_Core);
52     c->verbosity = 1;
53     c->use_armor = 1; /* fixme: reset this to 0 */
54     *r_ctx = c;
55
56     return 0;
57 }
58
59 /**
60  * gpgme_release:
61  * @c: Context to be released. 
62  * 
63  * Release all resources associated with the given context.
64  **/
65 void
66 gpgme_release ( GpgmeCtx c )
67 {
68     if (!c)
69         return;
70     _gpgme_gpg_release ( c->gpg ); 
71     _gpgme_release_result ( c );
72     _gpgme_key_release ( c->tmp_key );
73     gpgme_data_release ( c->help_data_1 );
74     gpgme_data_release ( c->notation );
75     /* fixme: release the key_queue */
76     xfree (c);
77 }
78
79
80 void
81 _gpgme_release_result ( GpgmeCtx c )
82 {
83     switch (c->result_type) {
84       case RESULT_TYPE_NONE:
85         break;
86       case RESULT_TYPE_VERIFY:
87         _gpgme_release_verify_result ( c->result.verify );
88         break;
89       case RESULT_TYPE_DECRYPT:
90         _gpgme_release_decrypt_result ( c->result.decrypt );
91         break;
92       case RESULT_TYPE_SIGN:
93         _gpgme_release_sign_result ( c->result.sign );
94         break;
95     }
96
97     c->result.verify = NULL;
98     c->result_type = RESULT_TYPE_NONE;
99 }
100
101
102 /**
103  * gpgme_get_notation:
104  * @c: the context 
105  * 
106  * If there is notation data available from the last signature check, this
107  * function may be used to return this notation data as a string.  The string
108  * is an XML represantaton of that data embedded in a %<notation> container.
109  * 
110  * Return value: An XML string or NULL if no notation data is available.
111  **/
112 char *
113 gpgme_get_notation ( GpgmeCtx c )
114 {
115     if ( !c->notation )
116         return NULL;
117     return _gpgme_data_get_as_string ( c->notation );
118 }
119
120
121 /**
122  * gpgme_set_armor:
123  * @c: the contect 
124  * @yes: boolean value to set or clear that flag
125  * 
126  * Enable or disable the use of an ascii armor for all output.  
127  **/
128 void
129 gpgme_set_armor ( GpgmeCtx c, int yes )
130 {
131     if ( !c )
132         return; /* oops */
133     c->use_armor = yes;
134 }
135
136 /**
137  * gpgme_set_textmode:
138  * @c: the context 
139  * @yes: boolean flag whether textmode should be enabled
140  * 
141  * Enable or disable the use of the special textmode.  Textmode is for example
142  * used for MIME (RFC2015) signatures
143  **/
144 void
145 gpgme_set_textmode ( GpgmeCtx c, int yes )
146 {
147     if ( !c )
148         return; /* oops */
149     c->use_textmode = yes;
150 }
151
152 /**
153  * gpgme_set_passphrase_cb:
154  * @c: the context 
155  * @cb: A callback function
156  * @cb_value: The value passed to the callback function
157  * 
158  * This function sets a callback function to be used to pass a passphrase
159  * to gpg. The preferred way to handle this is by using the gpg-agent, but
160  * because that beast is not ready for real use, you can use this passphrase
161  * thing.
162  *
163  * The callback function is defined as:
164  * <literal>
165  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
166  *                                          const char *desc,
167  *                                          void *r_hd);
168  * </literal>
169  * and called whenever gpgme needs a passphrase. DESC will have a nice
170  * text, to be used to prompt for the passphrase and R_HD is just a parameter
171  * to be used by the callback it self.  Becuase the callback returns a const
172  * string, the callback might want to know when it can releae resources
173  * assocated with that returned string; gpgme helps here by calling this
174  * passphrase callback with an DESC of %NULL as soon as it does not need
175  * the returned string anymore.  The callback function might then choose
176  * to release resources depending on R_HD.
177  *
178  **/
179 void
180 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
181 {
182     c->passphrase_cb = cb;
183     c->passphrase_cb_value = cb_value;
184 }
185
186 /**
187  * gpgme_set_pprogress_cb:
188  * @c: the context 
189  * @cb: A callback function
190  * @cb_value: The value passed to the callback function
191  * 
192  * This function sets a callback function to be used as a progress indicator.
193  *
194  * The callback function is defined as:
195  * <literal>
196  * typedef void (*GpgmeProgressCb) (void*cb_value,
197  *                                  const char *what, int type,
198  *                                  int curretn, int total);
199  * </literal>
200  * For details on the progress events, see the entry for the PROGRESS
201  * status in the file doc/DETAILS of the GnuPG distribution.
202  **/
203 void
204 gpgme_set_progress_cb ( GpgmeCtx c, GpgmeProgressCb cb, void *cb_value )
205 {
206     c->progress_cb = cb;
207     c->progress_cb_value = cb_value;
208 }
209
210