1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
# Unix SMB/CIFS implementation.
# Copyright (C) 2014 Catalyst.Net Ltd
#
# Auto generate param_functions.c
#
# ** NOTE! The following LGPL license applies to the ldb
# ** library. This does NOT imply that all of Samba is released
# ** under the LGPL
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, see <http://www.gnu.org/licenses/>.
#
import errno
import os
import re
import subprocess
import xml.etree.ElementTree as ET
import sys
import optparse
# parse command line arguments
parser = optparse.OptionParser()
parser.add_option("-f", "--file", dest="filename",
help="input file", metavar="FILE")
parser.add_option("-o", "--output", dest="output",
help='output file', metavar="FILE")
parser.add_option("--mode", type="choice", metavar="<FUNCTIONS|S3PROTO|LIBPROTO|PARAMDEFS>",
choices=["FUNCTIONS", "S3PROTO", "LIBPROTO", "PARAMDEFS"], default="FUNCTIONS")
parser.add_option("--scope", metavar="<GLOBAL|LOCAL>",
choices = ["GLOBAL", "LOCAL"], default="GLOBAL")
(options, args) = parser.parse_args()
if options.filename is None:
parser.error("No input file specified")
if options.output is None:
parser.error("No output file specified")
def iterate_all(path):
"""Iterate and yield all the parameters.
:param path: path to parameters xml file
"""
try:
p = open(path, 'r')
except IOError, e:
raise Exception("Error opening parameters file")
out = p.read()
# parse the parameters xml file
root = ET.fromstring(out)
for parameter in root:
name = parameter.attrib.get("name")
param_type = parameter.attrib.get("type")
context = parameter.attrib.get("context")
func = parameter.attrib.get("function")
synonym = parameter.attrib.get("synonym")
removed = parameter.attrib.get("removed")
generated = parameter.attrib.get("generated_function")
if synonym == "1" or removed == "1" or generated == "0":
continue
constant = parameter.attrib.get("constant")
parm = parameter.attrib.get("parm")
if name is None or param_type is None or context is None:
raise Exception("Error parsing parameter: " + name)
if func is None:
func = name.replace(" ", "_").lower()
yield {'name': name,
'type': param_type,
'context': context,
'function': func,
'constant': (constant == '1'),
'parm': (parm == '1')}
# map doc attributes to a section of the generated function
context_dict = {"G": "_GLOBAL", "S": "_LOCAL"}
param_type_dict = {"boolean": "_BOOL", "list": "_LIST", "string": "_STRING",
"integer": "_INTEGER", "enum": "_INTEGER", "char" : "_CHAR",
"boolean-auto": "_INTEGER"}
def generate_functions(path_in, path_out):
f = open(path_out, 'w')
try:
f.write('/* This file was automatically generated by generate_param.py. DO NOT EDIT */\n\n')
for parameter in iterate_all(options.filename):
# filter out parameteric options
if ':' in parameter['name']:
continue
output_string = "FN"
temp = context_dict.get(parameter['context'])
if temp is None:
raise Exception(parameter['name'] + " has an invalid context " + parameter['context'])
output_string += temp
if parameter['constant']:
output_string += "_CONST"
if parameter['parm']:
output_string += "_PARM"
temp = param_type_dict.get(parameter['type'])
if temp is None:
raise Exception(parameter['name'] + " has an invalid param type " + parameter['type'])
output_string += temp
f.write(output_string + "(" + parameter['function'] +", " + parameter['function'] + ')\n')
finally:
f.close()
mapping = {'boolean': 'bool ', 'string': 'char *', 'integer': 'int ', 'char': 'char ',
'list': 'const char **', 'enum': 'int ', 'boolean-auto': 'int '}
def make_s3_param_proto(path_in, path_out):
file_out = open(path_out, 'w')
try:
file_out.write('/* This file was automatically generated by generate_param.py. DO NOT EDIT */\n\n')
header = get_header(path_out)
file_out.write("#ifndef %s\n" % header)
file_out.write("#define %s\n\n" % header)
for parameter in iterate_all(path_in):
# filter out parameteric options
if ':' in parameter['name']:
continue
output_string = ""
if parameter['constant']:
output_string += 'const '
param_type = mapping.get(parameter['type'])
if param_type is None:
raise Exception(parameter['name'] + " has an invalid context " + parameter['context'])
output_string += param_type
output_string += "lp_%s" % parameter['function']
param = None
if parameter['parm']:
param = "const struct share_params *p"
else:
param = "int"
if parameter['type'] == 'string' and not parameter['constant']:
if parameter['context'] == 'G':
output_string += '(TALLOC_CTX *ctx);\n'
elif parameter['context'] == 'S':
output_string += '(TALLOC_CTX *ctx, %s);\n' % param
else:
raise Exception(parameter['name'] + " has an invalid param type " + parameter['type'])
else:
if parameter['context'] == 'G':
output_string += '(void);\n'
elif parameter['context'] == 'S':
output_string += '(%s);\n' % param
else:
raise Exception(parameter['name'] + " has an invalid param type " + parameter['type'])
file_out.write(output_string)
file_out.write("\n#endif /* %s */\n\n" % header)
finally:
file_out.close()
def make_lib_proto(path_in, path_out):
file_out = open(path_out, 'w')
try:
file_out.write('/* This file was automatically generated by generate_param.py. DO NOT EDIT */\n\n')
for parameter in iterate_all(path_in):
# filter out parameteric options
if ':' in parameter['name']:
continue
output_string = ""
if parameter['constant']:
output_string += 'const '
param_type = mapping.get(parameter['type'])
if param_type is None:
raise Exception(parameter['name'] + " has an invalid context " + parameter['context'])
output_string += param_type
output_string += "lpcfg_%s" % parameter['function']
if parameter['type'] == 'string' and not parameter['constant']:
if parameter['context'] == 'G':
output_string += '(struct loadparm_context *, TALLOC_CTX *ctx);\n'
elif parameter['context'] == 'S':
output_string += '(struct loadparm_service *, struct loadparm_service *, TALLOC_CTX *ctx);\n'
else:
raise Exception(parameter['name'] + " has an invalid param type " + parameter['type'])
else:
if parameter['context'] == 'G':
output_string += '(struct loadparm_context *);\n'
elif parameter['context'] == 'S':
output_string += '(struct loadparm_service *, struct loadparm_service *);\n'
else:
raise Exception(parameter['name'] + " has an invalid param type " + parameter['type'])
file_out.write(output_string)
finally:
file_out.close()
def get_header(path):
header = os.path.basename(path).upper()
header = header.replace(".", "_").replace("\\", "_").replace("-", "_")
return "__%s__" % header
def make_param_defs(path_in, path_out, scope):
file_out = open(path_out, 'w')
try:
file_out.write('/* This file was automatically generated by generate_param.py. DO NOT EDIT */\n\n')
header = get_header(path_out)
file_out.write("#ifndef %s\n" % header)
file_out.write("#define %s\n\n" % header)
if scope == "GLOBAL":
file_out.write("/**\n")
file_out.write(" * This structure describes global (ie., server-wide) parameters.\n")
file_out.write(" */\n")
file_out.write("struct loadparm_global \n")
file_out.write("{\n")
file_out.write("\tTALLOC_CTX *ctx; /* Context for talloced members */\n")
file_out.write("\tchar * dnsdomain;\n")
elif scope == "LOCAL":
file_out.write("/**\n")
file_out.write(" * This structure describes a single service.\n")
file_out.write(" */\n")
file_out.write("struct loadparm_service \n")
file_out.write("{\n")
file_out.write("\tbool autoloaded;\n")
for parameter in iterate_all(path_in):
# filter out parameteric options
if ':' in parameter['name']:
continue
if (scope == "GLOBAL" and parameter['context'] != "G" or
scope == "LOCAL" and parameter['context'] != "S"):
continue
output_string = "\t"
param_type = mapping.get(parameter['type'])
if param_type is None:
raise Exception(parameter['name'] + " has an invalid context " + parameter['context'])
output_string += param_type
output_string += " %s;\n" % parameter['function']
file_out.write(output_string)
file_out.write("LOADPARM_EXTRA_%sS\n" % scope)
file_out.write("};\n")
file_out.write("\n#endif /* %s */\n\n" % header)
finally:
file_out.close()
if options.mode == 'FUNCTIONS':
generate_functions(options.filename, options.output)
elif options.mode == 'S3PROTO':
make_s3_param_proto(options.filename, options.output)
elif options.mode == 'LIBPROTO':
make_lib_proto(options.filename, options.output)
elif options.mode == 'PARAMDEFS':
make_param_defs(options.filename, options.output, options.scope)
|
