pidl: Assert that python arrays will not overflow the C array
[kai/samba-autobuild/.git] / pidl / lib / Parse / Pidl / Samba4 / Python.pm
1 ###################################################
2 # Python function wrapper generator
3 # Copyright jelmer@samba.org 2007-2008
4 # released under the GNU GPL
5
6 package Parse::Pidl::Samba4::Python;
7
8 use Exporter;
9 @ISA = qw(Exporter);
10
11 use strict;
12 use Parse::Pidl qw(warning fatal error);
13 use Parse::Pidl::Typelist qw(hasType resolveType getType mapTypeName expandAlias bitmap_type_fn enum_type_fn);
14 use Parse::Pidl::Util qw(has_property ParseExpr unmake_str);
15 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
16 use Parse::Pidl::CUtil qw(get_value_of get_pointer_to);
17 use Parse::Pidl::Samba4 qw(ArrayDynamicallyAllocated);
18 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
19
20 use vars qw($VERSION);
21 $VERSION = '0.01';
22
23 sub new($) {
24         my ($class) = @_;
25         my $self = { res => "", res_hdr => "", tabs => "",
26                                  constants => [], constants_uniq => {},
27                      module_methods => [], module_objects => [], ready_types => [],
28                                  module_imports => [], module_imports_uniq => {},
29                                  type_imports => [], type_imports_uniq => {},
30                                  patch_type_calls => [], prereadycode => [],
31                                  postreadycode => []};
32         bless($self, $class);
33 }
34
35 sub pidl_hdr ($$)
36 {
37         my $self = shift;
38         $self->{res_hdr} .= shift;
39 }
40
41 sub pidl($$)
42 {
43         my ($self, $d) = @_;
44         if ($d) {
45                 if ((!($d =~ /^#/))) {
46                         $self->{res} .= $self->{tabs};
47                 }
48                 $self->{res} .= $d;
49         }
50         $self->{res} .= "\n";
51 }
52
53 sub indent($)
54 {
55         my ($self) = @_;
56         $self->{tabs} .= "\t";
57 }
58
59 sub deindent($)
60 {
61         my ($self) = @_;
62         $self->{tabs} = substr($self->{tabs}, 0, -1);
63 }
64
65 sub PrettifyTypeName($$)
66 {
67         my ($name, $basename) = @_;
68
69         $basename =~ s/^.*\.([^.]+)$/\1/;
70
71         $name =~ s/^$basename\_//;
72
73
74         return $name;
75 }
76
77 sub Import
78 {
79         my $self = shift;
80         my @imports = @_;
81         foreach (@imports) {
82                 $_ = unmake_str($_);
83                 s/\.idl$//;
84                 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
85                 $self->register_module_import("samba.dcerpc.$_");
86         }
87 }
88
89 sub Const($$)
90 {
91     my ($self, $const) = @_;
92         $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
93 }
94
95 sub register_constant($$$$)
96 {
97         my ($self, $name, $type, $value) = @_;
98
99         unless (defined $self->{constants_uniq}->{$name}) {
100                 my $h = {"key" => $name, "val" => [$type, $value]};
101                 push @{$self->{constants}}, $h;
102                 $self->{constants_uniq}->{$name} = $h;
103         }
104 }
105
106 sub EnumAndBitmapConsts($$$)
107 {
108         my ($self, $name, $d) = @_;
109
110         return unless (defined($d->{ELEMENTS}));
111
112         foreach my $e (@{$d->{ELEMENTS}}) {
113                 $e =~ /^([A-Za-z0-9_]+)/;
114                 my $cname = $1;
115
116                 $self->register_constant($cname, $d, $cname);
117         }
118 }
119
120 sub FromUnionToPythonFunction($$$$)
121 {
122         my ($self, $mem_ctx, $type, $switch, $name) = @_;
123
124         $self->pidl("PyObject *ret;");
125         $self->pidl("");
126
127         $self->pidl("switch ($switch) {");
128         $self->indent;
129
130         foreach my $e (@{$type->{ELEMENTS}}) {
131                 $self->pidl("$e->{CASE}:");
132
133                 $self->indent;
134
135                 if ($e->{NAME}) {
136                         $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
137                 } else {
138                         $self->pidl("ret = Py_None;");
139                         $self->pidl("Py_INCREF(ret);");
140                 }
141
142                 $self->pidl("return ret;");
143                 $self->pidl("");
144
145                 $self->deindent;
146         }
147
148         $self->deindent;
149         $self->pidl("}");
150
151         $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
152         $self->pidl("return NULL;");
153 }
154
155 sub FromPythonToUnionFunction($$$$$)
156 {
157         my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
158
159         my $has_default = 0;
160
161         $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
162
163         $self->pidl("switch ($switch) {");
164         $self->indent;
165
166         foreach my $e (@{$type->{ELEMENTS}}) {
167                 $self->pidl("$e->{CASE}:");
168                 if ($e->{CASE} eq "default") { $has_default = 1; }
169                 $self->indent;
170                 if ($e->{NAME}) {
171                         $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
172                 }
173                 $self->pidl("break;");
174                 $self->deindent;
175                 $self->pidl("");
176         }
177
178         if (!$has_default) {
179                 $self->pidl("default:");
180                 $self->indent;
181                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
182                 $self->pidl("talloc_free(ret);");
183                 $self->pidl("ret = NULL;");
184                 $self->deindent;
185         }
186
187         $self->deindent;
188         $self->pidl("}");
189         $self->pidl("");
190         $self->pidl("return ret;");
191 }
192
193 sub PythonStruct($$$$$$)
194 {
195         my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
196
197         my $env = GenerateStructEnv($d, "object");
198
199         $self->pidl("");
200
201         my $getsetters = "NULL";
202
203         if ($#{$d->{ELEMENTS}} > -1) {
204                 foreach my $e (@{$d->{ELEMENTS}}) {
205                         my $varname = "object->$e->{NAME}";
206                         $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
207                         $self->pidl("{");
208                         $self->indent;
209                         $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
210                         $self->pidl("PyObject *py_$e->{NAME};");
211                         $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
212                         $self->pidl("return py_$e->{NAME};");
213                         $self->deindent;
214                         $self->pidl("}");
215                         $self->pidl("");
216
217                         $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
218                         $self->pidl("{");
219                         $self->indent;
220                         $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
221                         my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
222                         my $l = $e->{LEVELS}[0];
223                         my $nl = GetNextLevel($e, $l);
224                         if ($l->{TYPE} eq "POINTER" and
225                                 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
226                                 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
227                                 $self->pidl("talloc_unlink(pytalloc_get_mem_ctx(py_obj), discard_const($varname));");
228                         }
229                         $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
230                         $self->pidl("return 0;");
231                         $self->deindent;
232                         $self->pidl("}");
233                         $self->pidl("");
234                 }
235
236                 $getsetters = "py_$name\_getsetters";
237                 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
238                 $self->indent;
239                 foreach my $e (@{$d->{ELEMENTS}}) {
240                         $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
241                 }
242                 $self->pidl("{ NULL }");
243                 $self->deindent;
244                 $self->pidl("};");
245                 $self->pidl("");
246         }
247
248         $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
249         $self->pidl("{");
250         $self->indent;
251         $self->pidl("return pytalloc_new($cname, type);");
252         $self->deindent;
253         $self->pidl("}");
254         $self->pidl("");
255
256         my $py_methods = "NULL";
257
258         # If the struct is not public there ndr_pull/ndr_push functions will
259         # be static so not callable from here
260         if (has_property($d, "public")) {
261                 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
262                 $self->pidl("{");
263                 $self->indent;
264                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
265                 $self->pidl("DATA_BLOB blob;");
266                 $self->pidl("enum ndr_err_code err;");
267                 $self->pidl("err = ndr_push_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
268                 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
269                 $self->indent;
270                 $self->pidl("PyErr_SetNdrError(err);");
271                 $self->pidl("return NULL;");
272                 $self->deindent;
273                 $self->pidl("}");
274                 $self->pidl("");
275                 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
276                 $self->deindent;
277                 $self->pidl("}");
278                 $self->pidl("");
279
280                 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
281                 $self->pidl("{");
282                 $self->indent;
283                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
284                 $self->pidl("DATA_BLOB blob;");
285                 $self->pidl("int blob_length = 0;");
286                 $self->pidl("enum ndr_err_code err;");
287                 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
288                 $self->pidl("PyObject *allow_remaining_obj = NULL;");
289                 $self->pidl("bool allow_remaining = false;");
290                 $self->pidl("");
291                 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
292                 $self->indent;
293                 $self->pidl("discard_const_p(char *, kwnames),");
294                 $self->pidl("&blob.data, &blob_length,");
295                 $self->pidl("&allow_remaining_obj)) {");
296                 $self->deindent;
297                 $self->indent;
298                 $self->pidl("return NULL;");
299                 $self->deindent;
300                 $self->pidl("}");
301                 $self->pidl("blob.length = blob_length;");
302                 $self->pidl("");
303                 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
304                 $self->indent;
305                 $self->pidl("allow_remaining = true;");
306                 $self->deindent;
307                 $self->pidl("}");
308                 $self->pidl("");
309                 $self->pidl("if (allow_remaining) {");
310                 $self->indent;
311                 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
312                 $self->deindent;
313                 $self->pidl("} else {");
314                 $self->indent;
315                 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
316                 $self->deindent;
317                 $self->pidl("}");
318                 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
319                 $self->indent;
320                 $self->pidl("PyErr_SetNdrError(err);");
321                 $self->pidl("return NULL;");
322                 $self->deindent;
323                 $self->pidl("}");
324                 $self->pidl("");
325                 $self->pidl("Py_RETURN_NONE;");
326                 $self->deindent;
327                 $self->pidl("}");
328                 $self->pidl("");
329
330                 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
331                 $self->pidl("{");
332                 $self->indent;
333                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
334                 $self->pidl("PyObject *ret;");
335                 $self->pidl("char *retstr;");
336                 $self->pidl("");
337                 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
338                 $self->pidl("ret = PyString_FromString(retstr);");
339                 $self->pidl("talloc_free(retstr);");
340                 $self->pidl("");
341                 $self->pidl("return ret;");
342                 $self->deindent;
343                 $self->pidl("}");
344                 $self->pidl("");
345
346                 $py_methods = "py_$name\_methods";
347                 $self->pidl("static PyMethodDef $py_methods\[] = {");
348                 $self->indent;
349                 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
350                 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
351                 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
352                 $self->pidl("{ NULL, NULL, 0, NULL }");
353                 $self->deindent;
354                 $self->pidl("};");
355                 $self->pidl("");
356         }
357
358         $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
359         $self->pidl("");
360         my $docstring = $self->DocString($d, $name);
361         my $typeobject = "$name\_Type";
362         $self->pidl("static PyTypeObject $typeobject = {");
363         $self->indent;
364         $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
365         $self->pidl(".tp_name = \"$modulename.$prettyname\",");
366         $self->pidl(".tp_getset = $getsetters,");
367         if ($docstring) {
368                 $self->pidl(".tp_doc = $docstring,");
369         }
370         $self->pidl(".tp_methods = $py_methods,");
371         $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
372         $self->pidl(".tp_basicsize = sizeof(pytalloc_Object),");
373         $self->pidl(".tp_new = py_$name\_new,");
374         $self->deindent;
375         $self->pidl("};");
376
377         $self->pidl("");
378
379         my $talloc_typename = $self->import_type_variable("talloc", "Object");
380         $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;", ""]);
381
382         return "&$typeobject";
383 }
384
385 sub get_metadata_var($)
386 {
387         my ($e) = @_;
388         sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
389
390          if (has_property($e, "length_is")) {
391                 return get_var($e->{PROPERTIES}->{length_is});
392          } elsif (has_property($e, "size_is")) {
393                 return get_var($e->{PROPERTIES}->{size_is});
394          }
395
396          return undef;
397 }
398
399 sub find_metadata_args($)
400 {
401         my ($fn) = @_;
402         my $metadata_args = { in => {}, out => {} };
403
404         # Determine arguments that are metadata for other arguments (size_is/length_is)
405         foreach my $e (@{$fn->{ELEMENTS}}) {
406                 foreach my $dir (@{$e->{DIRECTION}}) {
407                          my $main = get_metadata_var($e);
408                          if ($main) {
409                                  $metadata_args->{$dir}->{$main} = $e->{NAME};
410                          }
411                  }
412         }
413
414         return $metadata_args;
415 }
416
417 sub PythonFunctionUnpackOut($$$)
418 {
419         my ($self, $fn, $fnname) = @_;
420
421         my $outfnname = "unpack_$fnname\_args_out";
422         my $signature = "";
423
424         my $metadata_args = find_metadata_args($fn);
425
426         my $env = GenerateFunctionOutEnv($fn, "r->");
427         my $result_size = 0;
428
429         $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
430         $self->pidl("{");
431         $self->indent;
432         $self->pidl("PyObject *result;");
433         foreach my $e (@{$fn->{ELEMENTS}}) {
434                 next unless (grep(/out/,@{$e->{DIRECTION}}));
435                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
436                          ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
437                 $self->pidl("PyObject *py_$e->{NAME};");
438                 $result_size++;
439         }
440
441         if ($fn->{RETURN_TYPE}) {
442                 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
443         }
444
445         my $i = 0;
446
447         if ($result_size > 1) {
448                 $self->pidl("result = PyTuple_New($result_size);");
449                 $signature .= "(";
450         } elsif ($result_size == 0) {
451                 $self->pidl("result = Py_None;");
452                 $self->pidl("Py_INCREF(result);");
453                 $signature .= "None";
454         }
455
456         foreach my $e (@{$fn->{ELEMENTS}}) {
457                 next if ($metadata_args->{out}->{$e->{NAME}});
458                 my $py_name = "py_$e->{NAME}";
459                 if (grep(/out/,@{$e->{DIRECTION}})) {
460                         $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
461                         if ($result_size > 1) {
462                                 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
463                                 $i++;
464                                 $signature .= "$e->{NAME}, ";
465                         } else {
466                                 $self->pidl("result = $py_name;");
467                                 $signature .= $e->{NAME};
468                         }
469                 }
470         }
471
472         if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
473                 $self->handle_ntstatus("r->out.result", "NULL", undef);
474         } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
475                 $self->handle_werror("r->out.result", "NULL", undef);
476         } elsif (defined($fn->{RETURN_TYPE})) {
477                 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
478                 if ($result_size > 1) {
479                         $self->pidl("PyTuple_SetItem(result, $i, $conv);");
480                 } else {
481                         $self->pidl("result = $conv;");
482                 }
483                 $signature .= "result";
484         }
485
486         if (substr($signature, -2) eq ", ") {
487                 $signature = substr($signature, 0, -2);
488         }
489         if ($result_size > 1) {
490                 $signature .= ")";
491         }
492
493         $self->pidl("return result;");
494         $self->deindent;
495         $self->pidl("}");
496         $self->pidl("");
497
498         return ($outfnname, $signature);
499 }
500
501 sub PythonFunctionPackIn($$$)
502 {
503         my ($self, $fn, $fnname) = @_;
504         my $metadata_args = find_metadata_args($fn);
505
506         my $infnname = "pack_$fnname\_args_in";
507
508         $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
509         $self->pidl("{");
510         $self->indent;
511         my $args_format = "";
512         my $args_string = "";
513         my $args_names = "";
514         my $signature = "";
515
516         foreach my $e (@{$fn->{ELEMENTS}}) {
517                 next unless (grep(/in/,@{$e->{DIRECTION}}));
518                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
519                                  ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
520                 $self->pidl("PyObject *py_$e->{NAME};");
521                 $args_format .= "O";
522                 $args_string .= ", &py_$e->{NAME}";
523                 $args_names .= "\"$e->{NAME}\", ";
524                 $signature .= "$e->{NAME}, ";
525         }
526         if (substr($signature, -2) eq ", ") {
527                 $signature = substr($signature, 0, -2);
528         }
529         $self->pidl("const char *kwnames[] = {");
530         $self->indent;
531         $self->pidl($args_names . "NULL");
532         $self->deindent;
533         $self->pidl("};");
534
535         $self->pidl("");
536         $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
537         $self->indent;
538         $self->pidl("return false;");
539         $self->deindent;
540         $self->pidl("}");
541         $self->pidl("");
542
543         my $env = GenerateFunctionInEnv($fn, "r->");
544
545         my $fail = "return false;";
546         foreach my $e (@{$fn->{ELEMENTS}}) {
547                 next unless (grep(/in/,@{$e->{DIRECTION}}));
548                 if ($metadata_args->{in}->{$e->{NAME}}) {
549                         my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
550                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
551                         my $val = "PyList_GET_SIZE($py_var)";
552                         if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
553                                 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
554                                 $self->pidl("*r->in.$e->{NAME} = $val;");
555                         } else {
556                                 $self->pidl("r->in.$e->{NAME} = $val;");
557                         }
558                 } else {
559                         $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
560                 }
561         }
562         $self->pidl("return true;");
563         $self->deindent;
564         $self->pidl("}");
565         $self->pidl("");
566         return ($infnname, $signature);
567 }
568
569 sub PythonFunction($$$)
570 {
571         my ($self, $fn, $iface, $prettyname) = @_;
572
573         my $fnname = "py_$fn->{NAME}";
574         my $docstring = $self->DocString($fn, $fn->{NAME});
575
576         my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
577         my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
578         my $signature = "S.$prettyname($insignature) -> $outsignature";
579         if ($docstring) {
580                 $docstring = "\"$signature\\n\\n\"$docstring";
581         } else {
582                 $docstring = "\"$signature\"";
583         }
584
585         return ($infn, $outfn, $docstring);
586 }
587
588 sub handle_werror($$$$)
589 {
590         my ($self, $var, $retval, $mem_ctx) = @_;
591
592         $self->pidl("if (!W_ERROR_IS_OK($var)) {");
593         $self->indent;
594         $self->pidl("PyErr_SetWERROR($var);");
595         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
596         $self->pidl("return $retval;");
597         $self->deindent;
598         $self->pidl("}");
599         $self->pidl("");
600 }
601
602 sub handle_ntstatus($$$$)
603 {
604         my ($self, $var, $retval, $mem_ctx) = @_;
605
606         $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
607         $self->indent;
608         $self->pidl("PyErr_SetNTSTATUS($var);");
609         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
610         $self->pidl("return $retval;");
611         $self->deindent;
612         $self->pidl("}");
613         $self->pidl("");
614 }
615
616 sub PythonType($$$$)
617 {
618         my ($self, $modulename, $d, $interface, $basename) = @_;
619
620         my $actual_ctype = $d;
621         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
622                 $actual_ctype = $actual_ctype->{DATA};
623         }
624
625         if ($actual_ctype->{TYPE} eq "STRUCT") {
626                 my $typeobject;
627                 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
628
629                 if ($d->{TYPE} eq "STRUCT") {
630                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
631                 } else {
632                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
633                 }
634
635                 $self->register_module_typeobject($fn_name, $typeobject);
636         }
637
638         if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
639                 $self->EnumAndBitmapConsts($d->{NAME}, $d);
640         }
641
642         if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
643                 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
644         }
645
646         if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
647                 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
648                 $self->pidl_hdr("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in);\n");
649                 $self->pidl("{");
650                 $self->indent;
651                 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
652                 $self->deindent;
653                 $self->pidl("}");
654                 $self->pidl("");
655
656                 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
657                 $self->pidl_hdr(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in);\n");
658                 $self->pidl("{");
659                 $self->indent;
660                 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
661                 $self->deindent;
662                 $self->pidl("}");
663                 $self->pidl("");
664         }
665 }
666
667 sub DocString($$$)
668 {
669         my ($self, $d, $name) = @_;
670         if (has_property($d, "helpstring")) {
671                 my $docstring = uc("py_doc_$name");
672                 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
673                 return $docstring;
674         }
675
676         return undef;
677 }
678
679 sub Interface($$$)
680 {
681         my($self,$interface,$basename) = @_;
682
683         if (has_property($interface, "pyhelper")) {
684                 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
685         }
686
687         $self->Const($_) foreach (@{$interface->{CONSTS}});
688
689         foreach my $d (@{$interface->{TYPES}}) {
690                 next if has_property($d, "nopython");
691
692                 $self->PythonType($basename, $d, $interface, $basename);
693         }
694
695         if (defined $interface->{PROPERTIES}->{uuid}) {
696                 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
697                 $self->pidl("");
698
699                 my @fns = ();
700
701                 foreach my $d (@{$interface->{FUNCTIONS}}) {
702                         next if has_property($d, "noopnum");
703                         next if has_property($d, "nopython");
704                         next if has_property($d, "todo");
705
706                         my $skip = 0;
707                         foreach my $e (@{$d->{ELEMENTS}}) {
708                                 if (ContainsPipe($e, $e->{LEVELS}[0])) {
709                                         $skip = 1;
710                                         last;
711                                 }
712                         }
713                         next if $skip;
714
715                         my $prettyname = $d->{NAME};
716
717                         $prettyname =~ s/^$interface->{NAME}_//;
718                         $prettyname =~ s/^$basename\_//;
719
720                         my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
721
722                         push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
723                 }
724
725                 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
726                 $self->indent;
727                 foreach my $d (@fns) {
728                         my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
729                         $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
730                 }
731                 $self->pidl("{ NULL }");
732                 $self->deindent;
733                 $self->pidl("};");
734                 $self->pidl("");
735
736                 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
737                 $self->pidl("{");
738                 $self->indent;
739                 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
740                 $self->deindent;
741                 $self->pidl("}");
742
743                 $self->pidl("");
744
745                 my $signature =
746 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
747 \"\\n\"
748 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
749 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
750 \"credentials should be a credentials.Credentials object.\\n\\n\"";
751
752                 my $docstring = $self->DocString($interface, $interface->{NAME});
753
754                 if ($docstring) {
755                         $docstring = "$signature$docstring";
756                 } else {
757                         $docstring = $signature;
758                 }
759
760                 my $if_typename = "$interface->{NAME}_InterfaceType";
761
762                 $self->pidl("static PyTypeObject $if_typename = {");
763                 $self->indent;
764                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
765                 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
766                 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
767                 $self->pidl(".tp_doc = $docstring,");
768                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
769                 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
770                 $self->deindent;
771                 $self->pidl("};");
772
773                 $self->pidl("");
774
775                 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
776                 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
777                 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
778                 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
779
780
781                 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
782                 $self->pidl("{");
783                 $self->indent;
784                 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
785                 $self->deindent;
786                 $self->pidl("}");
787
788                 $self->pidl("");
789
790                 my $signature = "\"abstract_syntax()\\n\"";
791
792                 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
793
794                 if ($docstring) {
795                         $docstring = "$signature$docstring";
796                 } else {
797                         $docstring = $signature;
798                 }
799
800                 my $syntax_typename = "$interface->{NAME}_SyntaxType";
801
802                 $self->pidl("static PyTypeObject $syntax_typename = {");
803                 $self->indent;
804                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
805                 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
806                 $self->pidl(".tp_basicsize = sizeof(pytalloc_Object),");
807                 $self->pidl(".tp_doc = $docstring,");
808                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
809                 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
810                 $self->deindent;
811                 $self->pidl("};");
812
813                 $self->pidl("");
814
815                 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename");
816                 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
817                 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;", ""]);
818         }
819
820         $self->pidl_hdr("\n");
821 }
822
823 sub register_module_method($$$$$)
824 {
825         my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
826
827         push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
828 }
829
830 sub register_module_typeobject($$$)
831 {
832         my ($self, $name, $py_name) = @_;
833
834         $self->register_module_object($name, "(PyObject *)(void *)$py_name");
835
836         $self->check_ready_type($py_name);
837
838         $self->register_patch_type_call($name, $py_name);
839 }
840
841 sub check_ready_type($$)
842 {
843         my ($self, $py_name) = @_;
844         push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
845 }
846
847 sub register_module_import($$)
848 {
849         my ($self, $module_path) = @_;
850
851         my $var_name = $module_path;
852         $var_name =~ s/\./_/g;
853         $var_name = "dep_$var_name";
854
855         unless (defined $self->{module_imports_uniq}->{$var_name}) {
856                 my $h = { "key" => $var_name, "val" => $module_path};
857                 push @{$self->{module_imports}}, $h;
858                 $self->{module_imports_uniq}->{$var_name} = $h;
859         }
860         return $var_name;
861 }
862
863 sub import_type_variable($$$)
864 {
865         my ($self, $module, $name) = @_;
866
867         $self->register_module_import($module);
868         unless (defined $self->{type_imports_uniq}->{$name}) {
869                 my $h = { "key" => $name, "val" => $module};
870                 push @{$self->{type_imports}}, $h;
871                 $self->{type_imports_uniq}->{$name} = $h;
872         }
873         return "$name\_Type";
874 }
875
876 sub use_type_variable($$)
877 {
878         my ($self, $orig_ctype) = @_;
879         # FIXME: Have a global lookup table for types that look different on the
880         # wire than they are named in C?
881         if ($orig_ctype->{NAME} eq "dom_sid2" or
882             $orig_ctype->{NAME} eq "dom_sid28" or
883             $orig_ctype->{NAME} eq "dom_sid0") {
884                 $orig_ctype->{NAME} = "dom_sid";
885         }
886         if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
887                 $orig_ctype->{NAME} = "security_descriptor";
888         }
889
890         my $ctype = resolveType($orig_ctype);
891         unless (defined($ctype->{BASEFILE})) {
892                 return undef;
893         }
894         # If this is an external type, make sure we do the right imports.
895         if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
896                 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
897         }
898         return "&$ctype->{NAME}_Type";
899 }
900
901 sub register_patch_type_call($$$)
902 {
903         my ($self, $typename, $cvar) = @_;
904
905         push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
906
907 }
908
909 sub register_module_prereadycode($$)
910 {
911         my ($self, $code) = @_;
912
913         push (@{$self->{prereadycode}}, @$code);
914 }
915
916 sub register_module_postreadycode($$)
917 {
918         my ($self, $code) = @_;
919
920         push (@{$self->{postreadycode}}, @$code);
921 }
922
923 sub register_module_object($$$)
924 {
925         my ($self, $name, $py_name) = @_;
926
927         push (@{$self->{module_objects}}, [$name, $py_name])
928 }
929
930 sub assign($$$)
931 {
932         my ($self, $dest, $src) = @_;
933         if ($dest =~ /^\&/ and $src eq "NULL") {
934                 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
935         } elsif ($dest =~ /^\&/) {
936                 my $destvar = get_value_of($dest);
937                 $self->pidl("$destvar = *$src;");
938         } else {
939                 $self->pidl("$dest = $src;");
940         }
941 }
942
943 sub ConvertObjectFromPythonData($$$$$$;$)
944 {
945         my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
946
947         fatal($location, "undef type for $cvar") unless(defined($ctype));
948
949         $ctype = resolveType($ctype);
950
951         my $actual_ctype = $ctype;
952         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
953                 $actual_ctype = $actual_ctype->{DATA};
954         }
955
956         # We need to cover ENUMs, BITMAPS and SCALAR values here, as
957         # all could otherwise be assigned invalid integer values
958         my $ctype_alias = "";
959         my $uint_max = "";
960         if ($actual_ctype->{TYPE} eq "ENUM") {
961                 # Importantly, ENUM values are unsigned in pidl, and
962                 # typically map to uint32
963                 $ctype_alias = enum_type_fn($actual_ctype);
964         } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
965                 $ctype_alias = bitmap_type_fn($actual_ctype);
966         } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
967                 $ctype_alias = expandAlias($actual_ctype->{NAME});
968         }
969
970         # This is the unsigned Python Integer -> C integer validation
971         # case.  The signed case is below.
972         if ($ctype_alias  =~ /^(uint[0-9]*|hyper|udlong|udlongr
973                                 |NTTIME_hyper|NTTIME|NTTIME_1sec
974                                 |uid_t|gid_t)$/x) {
975                 $self->pidl("{");
976                 $self->indent;
977                 $self->pidl("const unsigned long long uint_max = (sizeof($target) == 8) ? UINT64_MAX : (unsigned long long)((1ULL << (sizeof($target) * 8)) - 1);");
978                 $self->pidl("if (PyLong_Check($cvar)) {");
979                 $self->indent;
980                 $self->pidl("unsigned long long test_var;");
981                 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
982                 $self->pidl("if (PyErr_Occurred() != NULL) {");
983                 $self->indent;
984                 $self->pidl($fail);
985                 $self->deindent;
986                 $self->pidl("}");
987                 $self->pidl("if (test_var > uint_max) {");
988                 $self->indent;
989                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
990                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
991                 $self->pidl($fail);
992                 $self->deindent;
993                 $self->pidl("}");
994                 $self->pidl("$target = test_var;");
995                 $self->deindent;
996                 $self->pidl("} else if (PyInt_Check($cvar)) {");
997                 $self->indent;
998                 $self->pidl("long test_var;");
999                 $self->pidl("test_var = PyInt_AsLong($cvar);");
1000                 $self->pidl("if (test_var < 0 || test_var > uint_max) {");
1001                 $self->indent;
1002                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1003                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1004                 $self->pidl($fail);
1005                 $self->deindent;
1006                 $self->pidl("}");
1007                 $self->pidl("$target = test_var;");
1008                 $self->deindent;
1009                 $self->pidl("} else {");
1010                 $self->indent;
1011                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1012                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
1013                 $self->pidl($fail);
1014                 $self->deindent;
1015                 $self->pidl("}");
1016                 $self->deindent;
1017                 $self->pidl("}");
1018                 return;
1019         }
1020
1021         # Confirm the signed python integer fits in the C type
1022         # correctly.  It is subtly different from the unsigned case
1023         # above, so while it looks like a duplicate, it is not
1024         # actually a duplicate.
1025         if ($ctype_alias  =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1026                 $self->pidl("{");
1027                 $self->indent;
1028                 $self->pidl("const long long int_max = (long long)((1ULL << (sizeof($target) * 8 - 1)) - 1);");
1029                 $self->pidl("const long long int_min = -int_max - 1;");
1030                 $self->pidl("if (PyLong_Check($cvar)) {");
1031                 $self->indent;
1032                 $self->pidl("long long test_var;");
1033                 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1034                 $self->pidl("if (PyErr_Occurred() != NULL) {");
1035                 $self->indent;
1036                 $self->pidl($fail);
1037                 $self->deindent;
1038                 $self->pidl("}");
1039                 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1040                 $self->indent;
1041                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1042                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1043                 $self->pidl($fail);
1044                 $self->deindent;
1045                 $self->pidl("}");
1046                 $self->pidl("$target = test_var;");
1047                 $self->deindent;
1048                 $self->pidl("} else if (PyInt_Check($cvar)) {");
1049                 $self->indent;
1050                 $self->pidl("long test_var;");
1051                 $self->pidl("test_var = PyInt_AsLong($cvar);");
1052                 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1053                 $self->indent;
1054                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1055                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1056                 $self->pidl($fail);
1057                 $self->deindent;
1058                 $self->pidl("}");
1059                 $self->pidl("$target = test_var;");
1060                 $self->deindent;
1061                 $self->pidl("} else {");
1062                 $self->indent;
1063                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1064                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
1065                 $self->pidl($fail);
1066                 $self->deindent;
1067                 $self->pidl("}");
1068                 $self->deindent;
1069                 $self->pidl("}");
1070                 return;
1071         }
1072
1073         if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1074                 my $ctype_name = $self->use_type_variable($ctype);
1075                 unless (defined ($ctype_name)) {
1076                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1077                         $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1078                         return;
1079                 }
1080                 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1081                 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1082                 $self->indent;
1083                 $self->pidl("PyErr_NoMemory();");
1084                 $self->pidl("$fail");
1085                 $self->deindent;
1086                 $self->pidl("}");
1087                 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1088                 return;
1089         }
1090
1091         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1092                 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
1093                 return;
1094         }
1095
1096         if ($actual_ctype->{TYPE} eq "SCALAR" and
1097                 ($actual_ctype->{NAME} eq "string" or $actual_ctype->{NAME} eq "nbt_string" or $actual_ctype->{NAME} eq "nbt_name" or $actual_ctype->{NAME} eq "wrepl_nbt_name")) {
1098                 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
1099                 return;
1100         }
1101
1102         if ($actual_ctype->{TYPE} eq "SCALAR" and ($actual_ctype->{NAME} eq "dns_string" or $actual_ctype->{NAME} eq "dns_name")) {
1103                 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
1104                 return;
1105         }
1106
1107         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
1108                 $self->pidl("$target = PyString_AS_STRING($cvar);");
1109                 return;
1110         }
1111
1112         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv6address") {
1113                 $self->pidl("$target = PyString_AsString($cvar);");
1114                 return;
1115         }
1116
1117         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
1118                 $self->pidl("$target = PyString_AS_STRING($cvar);");
1119                 return;
1120         }
1121
1122         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_string") {
1123                 $self->pidl("$target = PyString_AS_STRING($cvar);");
1124                 return;
1125         }
1126
1127         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1128                 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1129                 return;
1130         }
1131
1132         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1133                 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1134                 return;
1135         }
1136
1137         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1138                 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1139                 return;
1140         }
1141
1142         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1143                 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1144                 return;
1145         }
1146
1147         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1148                 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1149                 return;
1150         }
1151
1152         fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1153
1154 }
1155
1156 sub ConvertObjectFromPythonLevel($$$$$$$$)
1157 {
1158         my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1159         my $nl = GetNextLevel($e, $l);
1160         if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1161                 $nl = GetNextLevel($e, $nl);
1162         }
1163         my $pl = GetPrevLevel($e, $l);
1164         if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1165                 $pl = GetPrevLevel($e, $pl);
1166         }
1167
1168         if ($l->{TYPE} eq "POINTER") {
1169                 if ($l->{POINTER_TYPE} ne "ref") {
1170                         $self->pidl("if ($py_var == Py_None) {");
1171                         $self->indent;
1172                         $self->pidl("$var_name = NULL;");
1173                         $self->deindent;
1174                         $self->pidl("} else {");
1175                         $self->indent;
1176                 }
1177                 # if we want to handle more than one level of pointer in python interfaces
1178                 # then this is where we would need to allocate it
1179                 if ($l->{POINTER_TYPE} eq "ref") {
1180                         $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1181                 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1182                          and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1183                         $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1184                 } else {
1185                         $self->pidl("$var_name = NULL;");
1186                 }
1187                 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1188                         $var_name = get_value_of($var_name);
1189                 }
1190                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1191                 if ($l->{POINTER_TYPE} ne "ref") {
1192                         $self->deindent;
1193                         $self->pidl("}");
1194                 }
1195         } elsif ($l->{TYPE} eq "ARRAY") {
1196                 if ($pl && $pl->{TYPE} eq "POINTER") {
1197                         $var_name = get_pointer_to($var_name);
1198                 }
1199
1200                 if (is_charset_array($e, $l)) {
1201                         $self->pidl("if (PyUnicode_Check($py_var)) {");
1202                         $self->indent;
1203                         # FIXME: Use Unix charset setting rather than utf-8
1204                         $self->pidl($var_name . " = PyString_AS_STRING(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
1205                         $self->deindent;
1206                         $self->pidl("} else if (PyString_Check($py_var)) {");
1207                         $self->indent;
1208                         $self->pidl($var_name . " = PyString_AS_STRING($py_var);");
1209                         $self->deindent;
1210                         $self->pidl("} else {");
1211                         $self->indent;
1212                         $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1213                         $self->pidl("$fail");
1214                         $self->deindent;
1215                         $self->pidl("}");
1216                 } else {
1217                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1218                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1219                         $self->pidl("{");
1220                         $self->indent;
1221                         $self->pidl("int $counter;");
1222                         if (ArrayDynamicallyAllocated($e, $l)) {
1223                                 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1224                                 $self->pidl("if (!$var_name) { $fail; }");
1225                                 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1226                         } else {
1227                                 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1228                                 $self->indent;
1229                                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected list of type %s, length %zu, got %zd\", Py_TYPE($py_var)->tp_name, ARRAY_SIZE($var_name),  PyList_GET_SIZE($py_var));");
1230                                 $self->pidl("$fail");
1231                                 $self->deindent;
1232                                 $self->pidl("}");
1233                         }
1234                         $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1235                         $self->indent;
1236                         $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1237                         $self->deindent;
1238                         $self->pidl("}");
1239                         $self->deindent;
1240                         $self->pidl("}");
1241                 }
1242         } elsif ($l->{TYPE} eq "DATA") {
1243                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1244                         $var_name = get_pointer_to($var_name);
1245                 }
1246                 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1247         } elsif ($l->{TYPE} eq "SWITCH") {
1248                 $var_name = get_pointer_to($var_name);
1249                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1250                 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1251                 $self->pidl("{");
1252                 $self->indent;
1253                 my $union_type = mapTypeName($nl->{DATA_TYPE});
1254                 $self->pidl("$union_type *$switch_ptr;");
1255                 $self->pidl("$switch_ptr = py_export_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1256                 $self->fail_on_null($switch_ptr, $fail);
1257                 $self->assign($var_name, "$switch_ptr");
1258                 $self->deindent;
1259                 $self->pidl("}");
1260         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1261                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1262         } else {
1263                 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1264         }
1265 }
1266
1267 sub ConvertObjectFromPython($$$$$$$)
1268 {
1269         my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1270
1271         $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1272 }
1273
1274 sub ConvertScalarToPython($$$)
1275 {
1276         my ($self, $ctypename, $cvar) = @_;
1277
1278         die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1279
1280         $ctypename = expandAlias($ctypename);
1281
1282         if ($ctypename =~ /^(int64|dlong)$/) {
1283                 return "($cvar > LONG_MAX || $cvar < LONG_MIN) ? PyLong_FromLongLong($cvar) : PyInt_FromLong($cvar)";
1284         }
1285
1286         if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
1287                 return "$cvar > LONG_MAX ? PyLong_FromUnsignedLongLong($cvar) : PyInt_FromLong($cvar)";
1288         }
1289
1290         if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
1291                 return "PyInt_FromLong($cvar)";
1292         }
1293
1294         # Needed to ensure unsigned values in a 32 or 16 bit enum is
1295         # cast correctly to a uint32_t, not sign extended to a a
1296         # possibly 64 bit unsigned long.  (enums are signed in C,
1297         # unsigned in NDR)
1298         if ($ctypename =~ /^(uint32|uint3264)$/) {
1299                 return "(uint32_t)$cvar > LONG_MAX ? PyLong_FromUnsignedLong((uint32_t)$cvar) : PyInt_FromLong((uint32_t)$cvar)";
1300         }
1301
1302         if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
1303                 return "PyInt_FromLong((uint16_t)$cvar)";
1304         }
1305
1306         if ($ctypename eq "DATA_BLOB") {
1307                 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1308         }
1309
1310         if ($ctypename eq "NTSTATUS") {
1311                 return "PyErr_FromNTSTATUS($cvar)";
1312         }
1313
1314         if ($ctypename eq "WERROR") {
1315                 return "PyErr_FromWERROR($cvar)";
1316         }
1317
1318         if ($ctypename eq "HRESULT") {
1319                 return "PyErr_FromHRESULT($cvar)";
1320         }
1321
1322         if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1323                 return "PyString_FromStringOrNULL($cvar)";
1324         }
1325
1326         if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1327                 return "PyString_FromStringOrNULL($cvar)";
1328         }
1329
1330         # Not yet supported
1331         if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1332         if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1333         if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1334         if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1335         if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1336         if ($ctypename eq "pointer") {
1337                 return "pytalloc_CObject_FromTallocPtr($cvar)";
1338         }
1339
1340         die("Unknown scalar type $ctypename");
1341 }
1342
1343 sub ConvertObjectToPythonData($$$$$;$)
1344 {
1345         my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1346
1347         die("undef type for $cvar") unless(defined($ctype));
1348
1349         $ctype = resolveType($ctype);
1350
1351         my $actual_ctype = $ctype;
1352         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1353                 $actual_ctype = $actual_ctype->{DATA};
1354         }
1355
1356         if ($actual_ctype->{TYPE} eq "ENUM") {
1357                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1358         } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1359                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1360         } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1361                 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1362         } elsif ($actual_ctype->{TYPE} eq "UNION") {
1363                 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1364         } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1365                 my $ctype_name = $self->use_type_variable($ctype);
1366                 unless (defined($ctype_name)) {
1367                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1368                         return "NULL"; # FIXME!
1369                 }
1370                 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1371         }
1372
1373         fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1374 }
1375
1376 sub fail_on_null($$$)
1377 {
1378         my ($self, $var, $fail) = @_;
1379         $self->pidl("if ($var == NULL) {");
1380         $self->indent;
1381         $self->pidl($fail);
1382         $self->deindent;
1383         $self->pidl("}");
1384 }
1385
1386 sub ConvertObjectToPythonLevel($$$$$$)
1387 {
1388         my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1389         my $nl = GetNextLevel($e, $l);
1390         if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1391                 $nl = GetNextLevel($e, $nl);
1392         }
1393         my $pl = GetPrevLevel($e, $l);
1394         if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1395                 $pl = GetPrevLevel($e, $pl);
1396         }
1397
1398         if ($l->{TYPE} eq "POINTER") {
1399                 if ($l->{POINTER_TYPE} ne "ref") {
1400                         $self->pidl("if ($var_name == NULL) {");
1401                         $self->indent;
1402                         $self->pidl("$py_var = Py_None;");
1403                         $self->pidl("Py_INCREF($py_var);");
1404                         $self->deindent;
1405                         $self->pidl("} else {");
1406                         $self->indent;
1407                 }
1408                 my $var_name2 = $var_name;
1409                 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1410                         $var_name2 = get_value_of($var_name);
1411                 }
1412                 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1413                 if ($l->{POINTER_TYPE} ne "ref") {
1414                         $self->deindent;
1415                         $self->pidl("}");
1416                 }
1417         } elsif ($l->{TYPE} eq "ARRAY") {
1418                 if ($pl && $pl->{TYPE} eq "POINTER") {
1419                         $var_name = get_pointer_to($var_name);
1420                 }
1421
1422                 if (is_charset_array($e, $l)) {
1423                         # FIXME: Use Unix charset setting rather than utf-8
1424                         $self->pidl("if ($var_name == NULL) {");
1425                         $self->indent;
1426                         $self->pidl("$py_var = Py_None;");
1427                         $self->pidl("Py_INCREF($py_var);");
1428                         $self->deindent;
1429                         $self->pidl("} else {");
1430                         $self->indent;
1431                         $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1432                         $self->deindent;
1433                         $self->pidl("}");
1434                 } else {
1435                         die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1436                         my $length = $l->{SIZE_IS};
1437                         if (defined($l->{LENGTH_IS})) {
1438                                 $length = $l->{LENGTH_IS};
1439                         }
1440
1441                         $length = ParseExpr($length, $env, $e);
1442                         $self->pidl("$py_var = PyList_New($length);");
1443                         $self->fail_on_null($py_var, $fail);
1444                         $self->pidl("{");
1445                         $self->indent;
1446                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1447                         $self->pidl("int $counter;");
1448                         $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1449                         $self->indent;
1450                         my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1451                         $self->pidl("PyObject *$member_var;");
1452                         $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1453                         $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1454                         $self->deindent;
1455                         $self->pidl("}");
1456                         $self->deindent;
1457                         $self->pidl("}");
1458                 }
1459         } elsif ($l->{TYPE} eq "SWITCH") {
1460                 $var_name = get_pointer_to($var_name);
1461                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1462                 $self->pidl("$py_var = py_import_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1463                 $self->fail_on_null($py_var, $fail);
1464
1465         } elsif ($l->{TYPE} eq "DATA") {
1466                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1467                         $var_name = get_pointer_to($var_name);
1468                 }
1469                 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1470                 $self->pidl("$py_var = $conv;");
1471         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1472                 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1473         } else {
1474                 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1475         }
1476 }
1477
1478 sub ConvertObjectToPython($$$$$$)
1479 {
1480         my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1481
1482         $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1483 }
1484
1485 sub Parse($$$$$)
1486 {
1487     my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1488
1489         $self->{BASENAME} = $basename;
1490
1491     $self->pidl_hdr("
1492 /* Python wrapper functions auto-generated by pidl */
1493 #include <Python.h>
1494 #include \"includes.h\"
1495 #include <pytalloc.h>
1496 #include \"librpc/rpc/pyrpc.h\"
1497 #include \"librpc/rpc/pyrpc_util.h\"
1498 #include \"$hdr\"
1499 #include \"$ndr_hdr\"
1500
1501 ");
1502
1503         foreach my $x (@$ndr) {
1504                 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1505             ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1506         }
1507
1508         $self->pidl("static PyMethodDef $basename\_methods[] = {");
1509         $self->indent;
1510         foreach (@{$self->{module_methods}}) {
1511                 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1512                 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1513         }
1514
1515         $self->pidl("{ NULL, NULL, 0, NULL }");
1516         $self->deindent;
1517         $self->pidl("};");
1518
1519         $self->pidl("");
1520
1521         $self->pidl_hdr("void init$basename(void);");
1522         $self->pidl("void init$basename(void)");
1523         $self->pidl("{");
1524         $self->indent;
1525         $self->pidl("PyObject *m;");
1526         foreach my $h (@{$self->{module_imports}}) {
1527                 $self->pidl("PyObject *$h->{'key'};");
1528         }
1529         $self->pidl("");
1530
1531         foreach my $h (@{$self->{module_imports}}) {
1532                 my $var_name = $h->{'key'};
1533                 my $module_path = $h->{'val'};
1534                 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1535                 $self->pidl("if ($var_name == NULL)");
1536                 $self->pidl("\treturn;");
1537                 $self->pidl("");
1538         }
1539
1540         foreach my $h (@{$self->{type_imports}}) {
1541                 my $type_var = "$h->{'key'}\_Type";
1542                 my $module_path = $h->{'val'};
1543                 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1544                 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
1545                 my $module_var = "dep_$module_path";
1546                 $module_var =~ s/\./_/g;
1547                 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1548                 $self->pidl("if ($type_var == NULL)");
1549                 $self->pidl("\treturn;");
1550                 $self->pidl("");
1551         }
1552
1553         $self->pidl($_) foreach (@{$self->{prereadycode}});
1554
1555         foreach (@{$self->{ready_types}}) {
1556                 $self->pidl("if (PyType_Ready($_) < 0)");
1557                 $self->pidl("\treturn;");
1558         }
1559
1560         $self->pidl($_) foreach (@{$self->{postreadycode}});
1561
1562         foreach (@{$self->{patch_type_calls}}) {
1563                 my ($typename, $cvar) = @$_;
1564                 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1565                 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1566                 $self->pidl("#endif");
1567         }
1568
1569         $self->pidl("");
1570
1571         $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1572         $self->pidl("if (m == NULL)");
1573         $self->pidl("\treturn;");
1574         $self->pidl("");
1575         foreach my $h (@{$self->{constants}}) {
1576                 my $name = $h->{'key'};
1577                 my $py_obj;
1578                 my ($ctype, $cvar) = @{$h->{'val'}};
1579                 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1580                         $py_obj = "$cvar > LONG_MAX ? PyLong_FromUnsignedLongLong($cvar) : PyInt_FromLong($cvar)";
1581                 } elsif ($cvar =~ /^".*"$/) {
1582                         $py_obj = "PyString_FromString($cvar)";
1583                 } else {
1584                         $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1585                 }
1586
1587                 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1588         }
1589
1590         foreach (@{$self->{module_objects}}) {
1591                 my ($object_name, $c_name) = @$_;
1592                 $self->pidl("Py_INCREF($c_name);");
1593                 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1594         }
1595
1596         $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1597         $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1598         $self->pidl("#endif");
1599
1600         $self->pidl("");
1601         $self->deindent;
1602         $self->pidl("}");
1603     return ($self->{res_hdr} . $self->{res});
1604 }
1605
1606 1;