python: Adapt to 'gpgme_op_interact'.
[gpgme.git] / lang / python / gpgme.i
1 /*
2 # Copyright (C) 2016 g10 Code GmbH
3 # Copyright (C) 2004,2008 Igor Belyi <belyi@users.sourceforge.net>
4 # Copyright (C) 2002 John Goerzen <jgoerzen@complete.org>
5 #
6 #    This library is free software; you can redistribute it and/or
7 #    modify it under the terms of the GNU Lesser General Public
8 #    License as published by the Free Software Foundation; either
9 #    version 2.1 of the License, or (at your option) any later version.
10 #
11 #    This library 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 GNU
14 #    Lesser General Public License for more details.
15 #
16 #    You should have received a copy of the GNU Lesser General Public
17 #    License along with this library; if not, write to the Free Software
18 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
19 */
20 %module gpgme
21 %include "cpointer.i"
22 %include "cstring.i"
23
24 /* Generate doc strings for all methods.
25
26    This will generate docstrings of the form
27
28      gpgme_op_encrypt(ctx, recp, flags, plain, cipher) -> gpgme_error_t
29
30    which we transform into
31
32      ctx.op_encrypt(recp, flags, plain, cipher) -> gpgme_error_t
33
34    for automagically wrapped functions.  */
35 %feature("autodoc", "0");
36
37
38 /* Allow use of Unicode objects, bytes, and None for strings.  */
39 %typemap(in) const char *(PyObject *encodedInput = NULL) {
40   if ($input == Py_None)
41     $1 = NULL;
42   else if (PyUnicode_Check($input))
43     {
44       encodedInput = PyUnicode_AsUTF8String($input);
45       if (encodedInput == NULL)
46         return NULL;
47       $1 = PyBytes_AsString(encodedInput);
48     }
49   else if (PyBytes_Check($input))
50     $1 = PyBytes_AsString($input);
51   else {
52     PyErr_Format(PyExc_TypeError,
53                  "arg %d: expected str, bytes, or None, got %s",
54                  $argnum, $input->ob_type->tp_name);
55     return NULL;
56   }
57 }
58 %typemap(freearg) const char * {
59   Py_XDECREF(encodedInput$argnum);
60 }
61
62 /* Likewise for a list of strings.  */
63 %typemap(in) const char *[] (void *vector = NULL,
64                              size_t size,
65                              PyObject **pyVector = NULL) {
66   /* Check if is a list */
67   if (PyList_Check($input)) {
68     size_t i, j;
69     size = PyList_Size($input);
70     $1 = (char **) (vector = malloc((size+1) * sizeof(char *)));
71     pyVector = calloc(sizeof *pyVector, size);
72
73     for (i = 0; i < size; i++) {
74       PyObject *o = PyList_GetItem($input,i);
75       if (PyUnicode_Check(o))
76         {
77           pyVector[i] = PyUnicode_AsUTF8String(o);
78           if (pyVector[i] == NULL)
79             {
80               free(vector);
81               for (j = 0; j < i; j++)
82                 Py_XDECREF(pyVector[j]);
83               return NULL;
84             }
85           $1[i] = PyBytes_AsString(pyVector[i]);
86         }
87       else if (PyString_Check(o))
88         $1[i] = PyString_AsString(o);
89       else {
90         PyErr_Format(PyExc_TypeError,
91                      "arg %d: list must contain only str or bytes, got %s "
92                      "at position %d",
93                      $argnum, o->ob_type->tp_name, i);
94         free($1);
95         return NULL;
96       }
97     }
98     $1[i] = NULL;
99   } else {
100     PyErr_Format(PyExc_TypeError,
101                  "arg %d: expected a list of str or bytes, got %s",
102                  $argnum, $input->ob_type->tp_name);
103     return NULL;
104   }
105 }
106 %typemap(freearg) const char *[] {
107   size_t i;
108   free(vector$argnum);
109   for (i = 0; i < size$argnum; i++)
110     Py_XDECREF(pyVector$argnum[i]);
111 }
112
113 // Release returned buffers as necessary.
114 %typemap(newfree) char * "free($1);";
115 %newobject gpgme_data_release_and_get_mem;
116
117 %typemap(arginit) gpgme_key_t [] {
118   $1 = NULL;
119 }
120
121 %typemap(in) gpgme_key_t [] {
122   int i, numb = 0;
123   if (!PySequence_Check($input)) {
124     PyErr_Format(PyExc_ValueError, "arg %d: Expected a list of gpgme_key_t",
125                  $argnum);
126     return NULL;
127   }
128   if((numb = PySequence_Length($input)) != 0) {
129     $1 = (gpgme_key_t*)malloc((numb+1)*sizeof(gpgme_key_t));
130     for(i=0; i<numb; i++) {
131       PyObject *pypointer = PySequence_GetItem($input, i);
132
133       /* input = $input, 1 = $1, 1_descriptor = $1_descriptor */
134       /* &1_descriptor = $&1_descriptor *1_descriptor = $*1_descriptor */
135
136       // Following code is from swig's python.swg
137       if ((SWIG_ConvertPtr(pypointer,(void **) &$1[i], $*1_descriptor,SWIG_POINTER_EXCEPTION | $disown )) == -1) {
138         Py_DECREF(pypointer);
139         return NULL;
140       }
141       Py_DECREF(pypointer);
142     }
143     $1[numb] = NULL;
144   }
145 }
146 %typemap(freearg) gpgme_key_t [] {
147   if ($1) free($1);
148 }
149
150 // Special handling for references to our objects.
151 %typemap(in) gpgme_data_t DATAIN (gpgme_data_t wrapper = NULL,
152                                   PyObject *bytesio = NULL,
153                                   Py_buffer view, int have_view = 0) {
154   /* If we create a temporary wrapper object, we will store it in
155      wrapperN, where N is $argnum.  Here in this fragment, SWIG will
156      automatically append $argnum.  */
157   memset(&view, 0, sizeof view);
158   if ($input == Py_None)
159     $1 = NULL;
160   else {
161     PyObject *pypointer;
162     pypointer = _pyme_obj2gpgme_data_t($input, $argnum, &wrapper,
163                                        &bytesio, &view);
164     if (pypointer == NULL)
165       return NULL;
166     have_view = !! view.obj;
167
168     /* input = $input, 1 = $1, 1_descriptor = $1_descriptor */
169
170     // Following code is from swig's python.swg
171
172     if ((SWIG_ConvertPtr(pypointer,(void **) &$1, $1_descriptor,
173          SWIG_POINTER_EXCEPTION | $disown )) == -1) {
174       Py_DECREF(pypointer);
175       return NULL;
176     }
177     Py_DECREF(pypointer);
178   }
179 }
180
181 #if HAVE_DATA_H
182 /* If we are doing an in-tree build, we can use the internal
183    representation of struct gpgme_data for an very efficient check if
184    the buffer has been modified.  */
185 %{
186 #include "src/data.h"   /* For struct gpgme_data.  */
187 %}
188 #endif
189
190 %typemap(freearg) gpgme_data_t DATAIN {
191   /* See whether we need to update the Python buffer.  */
192   if (resultobj && wrapper$argnum && view$argnum.buf)
193     {
194       int dirty;
195       char *new_data = NULL;
196       size_t new_size;
197
198 #if HAVE_DATA_H
199       new_data = wrapper$argnum->data.mem.buffer;
200       new_size = wrapper$argnum->data.mem.length;
201       dirty = new_data != NULL;
202 #else
203       new_data = gpgme_data_release_and_get_mem (wrapper$argnum, &new_size);
204       wrapper$argnum = NULL;
205       dirty = new_size != view$argnum.len
206         || memcmp (new_data, view$argnum.buf, view$argnum.len);
207 #endif
208
209       if (dirty)
210         {
211           /* The buffer is dirty.  */
212           if (view$argnum.readonly)
213             {
214               Py_XDECREF(resultobj);
215               resultobj = NULL;
216               PyErr_SetString(PyExc_ValueError,
217                               "cannot update read-only buffer");
218             }
219
220           /* See if we need to truncate the buffer.  */
221           if (resultobj && view$argnum.len != new_size)
222             {
223               if (bytesio$argnum == NULL)
224                 {
225                   Py_XDECREF(resultobj);
226                   resultobj = NULL;
227                   PyErr_SetString(PyExc_ValueError, "cannot resize buffer");
228                 }
229               else
230                 {
231                   PyObject *retval;
232                   PyBuffer_Release(&view$argnum);
233                   assert(view$argnum.obj == NULL);
234                   retval = PyObject_CallMethod(bytesio$argnum, "truncate",
235                                                "l", (long) new_size);
236                   if (retval == NULL)
237                     {
238                       Py_XDECREF(resultobj);
239                       resultobj = NULL;
240                     }
241                   else
242                     {
243                       Py_DECREF(retval);
244
245                       retval = PyObject_CallMethod(bytesio$argnum,
246                                                    "getbuffer", NULL);
247                       if (retval == NULL
248                           || PyObject_GetBuffer(retval, &view$argnum,
249                                            PyBUF_SIMPLE|PyBUF_WRITABLE) < 0)
250                         {
251                           Py_XDECREF(resultobj);
252                           resultobj = NULL;
253                         }
254
255                       Py_XDECREF(retval);
256
257                       if (resultobj && view$argnum.len
258                           != new_size)
259                         {
260                           Py_XDECREF(resultobj);
261                           resultobj = NULL;
262                           PyErr_Format(PyExc_ValueError,
263                                        "Expected buffer of length %zu, got %zi",
264                                        new_size,
265                                        view$argnum.len);
266                         }
267                     }
268                 }
269             }
270           if (resultobj)
271             memcpy(view$argnum.buf, new_data, new_size);
272         }
273 #if ! HAVE_DATA_H
274       free (new_data);
275 #endif
276     }
277
278   /* Free the temporary wrapper, if any.  */
279   if (wrapper$argnum)
280     gpgme_data_release(wrapper$argnum);
281   Py_XDECREF (bytesio$argnum);
282   if (have_view$argnum && view$argnum.buf)
283     PyBuffer_Release(&view$argnum);
284 }
285
286 %apply gpgme_data_t DATAIN {gpgme_data_t plain, gpgme_data_t cipher,
287                         gpgme_data_t sig, gpgme_data_t signed_text,
288                         gpgme_data_t plaintext, gpgme_data_t keydata,
289                         gpgme_data_t pubkey, gpgme_data_t seckey,
290                         gpgme_data_t out};
291
292 /* SWIG has problems interpreting ssize_t, off_t or gpgme_error_t in
293    gpgme.h.  */
294 /* XXX: This is wrong at least for off_t if compiled with LFS.  */
295 %typemap(out) ssize_t, off_t, gpgme_error_t, gpgme_err_code_t, gpgme_err_source_t, gpg_error_t {
296   $result = PyLong_FromLong($1);
297 }
298 /* XXX: This is wrong at least for off_t if compiled with LFS.  */
299 %typemap(in) ssize_t, off_t, gpgme_error_t, gpgme_err_code_t, gpgme_err_source_t, gpg_error_t {
300   $1 = PyLong_AsLong($input);
301 }
302
303 // Those are for gpgme_data_read() and gpgme_strerror_r()
304 %typemap(in) (void *buffer, size_t size), (char *buf, size_t buflen) {
305    $2 = PyLong_AsLong($input);
306    if ($2 < 0) {
307      PyErr_SetString(PyExc_ValueError, "Positive integer expected");
308      return NULL;
309    }
310    $1 = ($1_ltype) malloc($2+1);
311 }
312 %typemap(argout) (void *buffer, size_t size), (char *buf, size_t buflen) {
313   Py_XDECREF($result);   /* Blow away any previous result */
314   if (result < 0) {      /* Check for I/O error */
315     free($1);
316     return PyErr_SetFromErrno(PyExc_RuntimeError);
317   }
318   $result = PyBytes_FromStringAndSize($1,result);
319   free($1);
320 }
321
322 /* For gpgme_data_write, but should be universal.  */
323 %typemap(in) (const void *buffer, size_t size)(PyObject *encodedInput = NULL) {
324   Py_ssize_t ssize;
325
326   if ($input == Py_None)
327     $1 = NULL, $2 = 0;
328   else if (PyUnicode_Check($input))
329     {
330       encodedInput = PyUnicode_AsUTF8String($input);
331       if (encodedInput == NULL)
332         return NULL;
333       if (PyBytes_AsStringAndSize(encodedInput, (char **) &$1, &ssize) == -1)
334         {
335           Py_DECREF(encodedInput);
336           return NULL;
337         }
338     }
339   else if (PyBytes_Check($input))
340     PyBytes_AsStringAndSize($input, (char **) &$1, &ssize);
341   else {
342     PyErr_Format(PyExc_TypeError,
343                  "arg %d: expected str, bytes, or None, got %s",
344                  $argnum, $input->ob_type->tp_name);
345     return NULL;
346   }
347
348   if (! $1)
349     $2 = 0;
350   else
351     {
352       assert (ssize >= 0);
353       $2 = (size_t) ssize;
354     }
355 }
356 %typemap(freearg) (const void *buffer, size_t size) {
357   Py_XDECREF(encodedInput$argnum);
358 }
359
360 // Make types containing 'next' field to be lists
361 %ignore next;
362 %typemap(out) gpgme_sig_notation_t, gpgme_subkey_t,
363    gpgme_key_sig_t, gpgme_user_id_t, gpgme_invalid_key_t,
364    gpgme_recipient_t, gpgme_new_signature_t, gpgme_signature_t,
365    gpgme_import_status_t, gpgme_conf_arg_t, gpgme_conf_opt_t,
366    gpgme_conf_comp_t, gpgme_tofu_info_t {
367   int i;
368   int size = 0;
369   $1_ltype curr;
370   for (curr = $1; curr != NULL; curr = curr->next) {
371     size++;
372   }
373   $result = PyList_New(size);
374   for (i=0,curr=$1; i<size; i++,curr=curr->next) {
375     PyObject *o = SWIG_NewPointerObj(SWIG_as_voidptr(curr), $1_descriptor, %newpointer_flags);
376     PyList_SetItem($result, i, o);
377   }
378 }
379
380 \f
381
382 /* Wrap the fragile result objects into robust Python ones.  */
383 %typemap(out) gpgme_encrypt_result_t {
384   PyObject *fragile;
385   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
386                                %newpointer_flags);
387   $result = _pyme_wrap_result(fragile, "EncryptResult");
388   Py_DECREF(fragile);
389 }
390
391 %typemap(out) gpgme_decrypt_result_t {
392   PyObject *fragile;
393   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
394                                %newpointer_flags);
395   $result = _pyme_wrap_result(fragile, "DecryptResult");
396   Py_DECREF(fragile);
397 }
398
399 %typemap(out) gpgme_sign_result_t {
400   PyObject *fragile;
401   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
402                                %newpointer_flags);
403   $result = _pyme_wrap_result(fragile, "SignResult");
404   Py_DECREF(fragile);
405 }
406
407 %typemap(out) gpgme_verify_result_t {
408   PyObject *fragile;
409   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
410                                %newpointer_flags);
411   $result = _pyme_wrap_result(fragile, "VerifyResult");
412   Py_DECREF(fragile);
413 }
414
415 %typemap(out) gpgme_import_result_t {
416   PyObject *fragile;
417   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
418                                %newpointer_flags);
419   $result = _pyme_wrap_result(fragile, "ImportResult");
420   Py_DECREF(fragile);
421 }
422
423 %typemap(out) gpgme_genkey_result_t {
424   PyObject *fragile;
425   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
426                                %newpointer_flags);
427   $result = _pyme_wrap_result(fragile, "GenkeyResult");
428   Py_DECREF(fragile);
429 }
430
431 %typemap(out) gpgme_keylist_result_t {
432   PyObject *fragile;
433   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
434                                %newpointer_flags);
435   $result = _pyme_wrap_result(fragile, "KeylistResult");
436   Py_DECREF(fragile);
437 }
438
439 %typemap(out) gpgme_vfs_mount_result_t {
440   PyObject *fragile;
441   fragile = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor,
442                                %newpointer_flags);
443   $result = _pyme_wrap_result(fragile, "VFSMountResult");
444   Py_DECREF(fragile);
445 }
446
447 %typemap(out) gpgme_engine_info_t {
448   int i;
449   int size = 0;
450   $1_ltype curr;
451   for (curr = $1; curr != NULL; curr = curr->next) {
452     size++;
453   }
454   $result = PyList_New(size);
455   if ($result == NULL)
456     return NULL;        /* raise */
457   for (i=0,curr=$1; i<size; i++,curr=curr->next) {
458     PyObject *fragile, *o;
459     fragile = SWIG_NewPointerObj(SWIG_as_voidptr(curr), $1_descriptor,
460                                  %newpointer_flags);
461     if (fragile == NULL)
462       {
463         Py_DECREF($result);
464         return NULL;    /* raise */
465       }
466     o = _pyme_wrap_result(fragile, "EngineInfo");
467     Py_DECREF(fragile);
468     if (o == NULL)
469       {
470         Py_DECREF($result);
471         return NULL;    /* raise */
472       }
473     PyList_SetItem($result, i, o);
474   }
475 }
476
477 \f
478
479 /* Include mapper for interact callbacks.  */
480 %typemap(in) (gpgme_interact_cb_t fnc, void *fnc_value) {
481   if (! PyTuple_Check($input))
482     return PyErr_Format(PyExc_TypeError, "interact callback must be a tuple");
483   if (PyTuple_Size($input) != 2 && PyTuple_Size($input) != 3)
484     return PyErr_Format(PyExc_TypeError,
485                         "interact callback must be a tuple of size 2 or 3");
486
487   $1 = (gpgme_interact_cb_t) _pyme_interact_cb;
488   $2 = $input;
489 }
490
491 \f
492
493 /* The assuan protocol callbacks.  */
494 %typemap(in) (gpgme_assuan_data_cb_t data_cb, void *data_cb_value) {
495   if ($input == Py_None)
496     $1 = $2 = NULL;
497   else
498     {
499       if (! PyTuple_Check($input))
500         return PyErr_Format(PyExc_TypeError, "callback must be a tuple");
501       if (PyTuple_Size($input) != 2)
502         return PyErr_Format(PyExc_TypeError,
503                             "callback must be a tuple of size 2");
504       if (! PyCallable_Check(PyTuple_GetItem($input, 1)))
505         return PyErr_Format(PyExc_TypeError, "second item must be callable");
506       $1 = _pyme_assuan_data_cb;
507       $2 = $input;
508     }
509 }
510
511 %typemap(in) (gpgme_assuan_inquire_cb_t inq_cb, void *inq_cb_value) {
512   if ($input == Py_None)
513     $1 = $2 = NULL;
514   else
515     {
516       if (! PyTuple_Check($input))
517         return PyErr_Format(PyExc_TypeError, "callback must be a tuple");
518       if (PyTuple_Size($input) != 2)
519         return PyErr_Format(PyExc_TypeError,
520                             "callback must be a tuple of size 2");
521       if (! PyCallable_Check(PyTuple_GetItem($input, 1)))
522         return PyErr_Format(PyExc_TypeError, "second item must be callable");
523       $1 = _pyme_assuan_inquire_cb;
524       $2 = $input;
525     }
526 }
527
528 %typemap(in) (gpgme_assuan_status_cb_t stat_cb, void *stat_cb_value) {
529   if ($input == Py_None)
530     $1 = $2 = NULL;
531   else
532     {
533       if (! PyTuple_Check($input))
534         return PyErr_Format(PyExc_TypeError, "callback must be a tuple");
535       if (PyTuple_Size($input) != 2)
536         return PyErr_Format(PyExc_TypeError,
537                             "callback must be a tuple of size 2");
538       if (! PyCallable_Check(PyTuple_GetItem($input, 1)))
539         return PyErr_Format(PyExc_TypeError, "second item must be callable");
540       $1 = _pyme_assuan_status_cb;
541       $2 = $input;
542     }
543 }
544
545 /* Include the unmodified <gpgme.h> for cc, and the cleaned-up local
546    version for SWIG.  We do, however, want to hide certain fields on
547    some structs, which we provide prior to including the version for
548    SWIG.  */
549 %{
550 #include <gpgme.h>
551 %}
552
553 /* This is for notations, where we want to hide the length fields, and
554    the unused bit field block.  */
555 struct _gpgme_sig_notation
556 {
557   struct _gpgme_sig_notation *next;
558
559   /* If NAME is a null pointer, then VALUE contains a policy URL
560      rather than a notation.  */
561   char *name;
562
563   /* The value of the notation data.  */
564   char *value;
565
566   /* The accumulated flags.  */
567   gpgme_sig_notation_flags_t flags;
568
569   /* Notation data is human-readable.  */
570   unsigned int human_readable : 1;
571
572   /* Notation data is critical.  */
573   unsigned int critical : 1;
574 };
575
576 /* Now include our local modified version.  Any structs defined above
577    are ignored.  */
578 %include "gpgme.h"
579
580 %include "errors.i"
581
582 // Generating and handling pointers-to-pointers.
583
584 %pointer_functions(gpgme_ctx_t, gpgme_ctx_t_p);
585 %pointer_functions(gpgme_data_t, gpgme_data_t_p);
586 %pointer_functions(gpgme_key_t, gpgme_key_t_p);
587 %pointer_functions(gpgme_error_t, gpgme_error_t_p);
588 %pointer_functions(gpgme_trust_item_t, gpgme_trust_item_t_p);
589 %pointer_functions(gpgme_engine_info_t, gpgme_engine_info_t_p);
590
591 // Helper functions.
592
593 %{
594 #include <stdio.h>
595 %}
596 FILE *fdopen(int fildes, const char *mode);
597
598 /* We include both headers in the generated c code...  */
599 %{
600 #include "helpers.h"
601 #include "private.h"
602
603 /* SWIG runtime support for helpers.c  */
604 PyObject *
605 _pyme_wrap_gpgme_data_t(gpgme_data_t data)
606 {
607   return SWIG_Python_NewPointerObj(NULL, data, SWIGTYPE_p_gpgme_data, 0);
608 }
609
610 gpgme_ctx_t
611 _pyme_unwrap_gpgme_ctx_t(PyObject *wrapped)
612 {
613   gpgme_ctx_t result;
614   if (SWIG_ConvertPtr(wrapped,
615                       (void **) &result,
616                       SWIGTYPE_p_gpgme_context,
617                       SWIG_POINTER_EXCEPTION) == -1)
618     return NULL;
619   return result;
620 }
621 %}
622
623 /* ... but only the public definitions here.  They will be exposed to
624    the Python world, so let's be careful.  */
625 %include "helpers.h"