Made gpgme_cancel work - at least a little bit.
[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     *r_ctx = c;
54
55     return 0;
56 }
57
58 /**
59  * gpgme_release:
60  * @c: Context to be released. 
61  * 
62  * Release all resources associated with the given context.
63  **/
64 void
65 gpgme_release ( GpgmeCtx c )
66 {
67     if (!c)
68         return;
69     _gpgme_gpg_release ( c->gpg ); 
70     _gpgme_release_result ( c );
71     gpgme_key_release ( c->tmp_key );
72     gpgme_data_release ( c->help_data_1 );
73     gpgme_data_release ( c->notation );
74     gpgme_signers_clear (c);
75     if (c->signers)
76         xfree (c->signers);
77     /* fixme: release the key_queue */
78     xfree (c);
79 }
80
81
82 void
83 _gpgme_release_result ( GpgmeCtx c )
84 {
85     switch (c->result_type) {
86       case RESULT_TYPE_NONE:
87         break;
88       case RESULT_TYPE_VERIFY:
89         _gpgme_release_verify_result ( c->result.verify );
90         break;
91       case RESULT_TYPE_DECRYPT:
92         _gpgme_release_decrypt_result ( c->result.decrypt );
93         break;
94       case RESULT_TYPE_SIGN:
95         _gpgme_release_sign_result ( c->result.sign );
96         break;
97     }
98
99     c->result.verify = NULL;
100     c->result_type = RESULT_TYPE_NONE;
101 }
102
103
104 /**
105  * gpgme_cancel:
106  * @c: the context
107  * 
108  * Cancel the current operation.  It is not guaranteed that it will work for
109  * all kinds of operations.  It is especially useful in a passphrase callback
110  * to stop the system from asking another time for the passphrase.
111  **/
112
113 void
114 gpgme_cancel (GpgmeCtx c)
115 {
116     return_if_fail (c);
117
118     c->cancel = 1;
119 }
120
121 /**
122  * gpgme_get_notation:
123  * @c: the context 
124  * 
125  * If there is notation data available from the last signature check, this
126  * function may be used to return this notation data as a string.  The string
127  * is an XML represantaton of that data embedded in a %<notation> container.
128  * 
129  * Return value: An XML string or NULL if no notation data is available.
130  **/
131 char *
132 gpgme_get_notation ( GpgmeCtx c )
133 {
134     if ( !c->notation )
135         return NULL;
136     return _gpgme_data_get_as_string ( c->notation );
137 }
138
139 /**
140  * gpgme_set_armor:
141  * @c: the contect 
142  * @yes: boolean value to set or clear that flag
143  * 
144  * Enable or disable the use of an ascii armor for all output.  
145  **/
146 void
147 gpgme_set_armor ( GpgmeCtx c, int yes )
148 {
149     if ( !c )
150         return; /* oops */
151     c->use_armor = yes;
152 }
153
154 /**
155  * gpgme_set_textmode:
156  * @c: the context 
157  * @yes: boolean flag whether textmode should be enabled
158  * 
159  * Enable or disable the use of the special textmode.  Textmode is for example
160  * used for MIME (RFC2015) signatures
161  **/
162 void
163 gpgme_set_textmode ( GpgmeCtx c, int yes )
164 {
165     if ( !c )
166         return; /* oops */
167     c->use_textmode = yes;
168 }
169
170 /**
171  * gpgme_set_keylist_mode:
172  * @c: the context
173  * @mode: listing mode
174  * 
175  * This function changes the default behaviour of the keylisting functions.
176  * Defines values for @mode are: %0 = normal, %1 = fast listing without
177  * information about key validity.
178  **/
179 void
180 gpgme_set_keylist_mode ( GpgmeCtx c, int mode )
181 {
182     if (!c)
183         return;
184     c->keylist_mode = mode;
185 }
186
187
188 /**
189  * gpgme_set_passphrase_cb:
190  * @c: the context 
191  * @cb: A callback function
192  * @cb_value: The value passed to the callback function
193  * 
194  * This function sets a callback function to be used to pass a passphrase
195  * to gpg. The preferred way to handle this is by using the gpg-agent, but
196  * because that beast is not ready for real use, you can use this passphrase
197  * thing.
198  *
199  * The callback function is defined as:
200  * <literal>
201  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
202  *                                          const char *desc,
203  *                                          void *r_hd);
204  * </literal>
205  * and called whenever gpgme needs a passphrase. DESC will have a nice
206  * text, to be used to prompt for the passphrase and R_HD is just a parameter
207  * to be used by the callback it self.  Becuase the callback returns a const
208  * string, the callback might want to know when it can release resources
209  * assocated with that returned string; gpgme helps here by calling this
210  * passphrase callback with an DESC of %NULL as soon as it does not need
211  * the returned string anymore.  The callback function might then choose
212  * to release resources depending on R_HD.
213  *
214  **/
215 void
216 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
217 {
218     c->passphrase_cb = cb;
219     c->passphrase_cb_value = cb_value;
220 }
221
222 /**
223  * gpgme_set_pprogress_cb:
224  * @c: the context 
225  * @cb: A callback function
226  * @cb_value: The value passed to the callback function
227  * 
228  * This function sets a callback function to be used as a progress indicator.
229  *
230  * The callback function is defined as:
231  * <literal>
232  * typedef void (*GpgmeProgressCb) (void*cb_value,
233  *                                  const char *what, int type,
234  *                                  int curretn, int total);
235  * </literal>
236  * For details on the progress events, see the entry for the PROGRESS
237  * status in the file doc/DETAILS of the GnuPG distribution.
238  **/
239 void
240 gpgme_set_progress_cb ( GpgmeCtx c, GpgmeProgressCb cb, void *cb_value )
241 {
242     c->progress_cb = cb;
243     c->progress_cb_value = cb_value;
244 }
245
246
247
248
249
250
251
252
253