3 import string, Logs, Utils, Options, Build, os, optparse, textwrap
4 from samba_utils import EXPAND_VARIABLES, os_path_relpath
6 class SambaIndentedHelpFormatter (optparse.IndentedHelpFormatter):
7 """Format help with indented section bodies.
15 optparse.IndentedHelpFormatter.__init__(
16 self, indent_increment, max_help_position, width, short_first)
18 def format_option(self, option):
19 # The help for each option consists of two parts:
20 # * the opt strings and metavars
21 # eg. ("-x", or "-fFILENAME, --file=FILENAME")
22 # * the user-supplied help string
23 # eg. ("turn on expert mode", "read data from FILENAME")
25 # If possible, we write both of these on the same line:
26 # -x turn on expert mode
28 # But if the opt string list is too long, we put the help
29 # string on a second line, indented to the same column it would
30 # start in if it fit on the first line.
31 # -fFILENAME, --file=FILENAME
32 # read data from FILENAME
34 opts = self.option_strings[option]
35 opt_width = self.help_position - self.current_indent - 2
36 if len(opts) > opt_width:
37 opts = "%*s%s\n" % (self.current_indent, "", opts)
38 indent_first = self.help_position
39 else: # start help on same line as opts
40 opts = "%*s%-*s " % (self.current_indent, "", opt_width, opts)
44 help_text = self.expand_default(option)
45 if string.find(help_text, '\n') == -1:
46 help_lines = textwrap.wrap(help_text, self.help_width)
48 help_lines = help_text.splitlines()
49 result.append("%*s%s\n" % (indent_first, "", help_lines[0]))
50 result.extend(["%*s%s\n" % (self.help_position, "", line)
51 for line in help_lines[1:]])
52 elif opts[-1] != "\n":
54 return "".join(result)
57 # list of directory options to offer in configure
59 # 'STD-PATH' - the default path without --enable-fhs
60 # 'FHS-PATH' - the default path with --enable-fhs
62 # 'OPTION' - the configure option to overwrite the default (optional)
63 # 'HELPTEXT' - the help text of the configure option (optional)
65 # 'OVERWRITE' - The option referrs to itself and was already from
66 # the basic GNU options from the gnu_dirs tool.
67 # We may overwrite the related path. (Default: False)
69 # 'DELAY' - The option referrs to other options in the dynconfig list.
70 # We delay the intialization into a later stage. This
71 # makes sure the recursion works. (Default: False)
75 'STD-PATH': '${BINDIR}',
76 'FHS-PATH': '${BINDIR}',
80 'STD-PATH': '${SBINDIR}',
81 'FHS-PATH': '${SBINDIR}',
85 'STD-PATH': '${LIBDIR}',
86 'FHS-PATH': '${LIBDIR}',
90 'STD-PATH': '${LIBEXECDIR}',
91 'FHS-PATH': '${LIBEXECDIR}',
95 'STD-PATH': '${DATADIR}',
96 'FHS-PATH': '${DATADIR}',
100 'STD-PATH': '${LOCALEDIR}',
101 'FHS-PATH': '${LOCALEDIR}',
105 'STD-PATH': '${PYTHONDIR}',
106 'FHS-PATH': '${PYTHONDIR}',
110 'STD-PATH': '${PYTHONARCHDIR}',
111 'FHS-PATH': '${PYTHONARCHDIR}',
114 'PERL_LIB_INSTALL_DIR' : {
115 'STD-PATH': '${PERL_LIB_INSTALL_DIR}',
116 'FHS-PATH': '${PERL_LIB_INSTALL_DIR}',
119 'PERL_ARCH_INSTALL_DIR' : {
120 'STD-PATH': '${PERL_ARCH_INSTALL_DIR}',
121 'FHS-PATH': '${PERL_ARCH_INSTALL_DIR}',
125 'STD-PATH': '${INCLUDEDIR}',
126 'FHS-PATH': '${INCLUDEDIR}/samba-4.0',
130 'STD-PATH': '${SBINDIR}',
131 'FHS-PATH': '${SBINDIR}',
134 'STD-PATH': '${DATADIR}/setup',
135 'FHS-PATH': '${DATADIR}/samba/setup',
138 'STD-PATH': '${LIBDIR}/pkgconfig',
139 'FHS-PATH': '${LIBDIR}/pkgconfig',
142 'STD-PATH': '${DATADIR}/codepages',
143 'FHS-PATH': '${DATADIR}/samba/codepages',
146 'STD-PATH': '${LIBDIR}/private',
147 'FHS-PATH': '${LIBDIR}/samba',
148 'OPTION': '--with-privatelibdir',
149 'HELPTEXT': 'Which directory to use for private Samba libraries',
153 'STD-PATH': '${LIBDIR}',
154 'FHS-PATH': '${LIBDIR}/samba',
155 'OPTION': '--with-modulesdir',
156 'HELPTEXT': 'Which directory to use for Samba modules',
160 'STD-PATH': '${LIBDIR}/security',
161 'FHS-PATH': '${LIBDIR}/security',
162 'OPTION': '--with-pammodulesdir',
163 'HELPTEXT': 'Which directory to use for PAM modules',
166 'STD-PATH': '${SYSCONFDIR}',
167 'FHS-PATH': '${SYSCONFDIR}/samba',
168 'OPTION': '--with-configdir',
169 'HELPTEXT': 'Where to put configuration files',
172 'STD-PATH': '${PREFIX}/private',
173 'FHS-PATH': '${LOCALSTATEDIR}/lib/samba/private',
174 'OPTION': '--with-privatedir',
175 'HELPTEXT': 'Where to put sam.ldb and other private files',
178 'STD-PATH': '${LOCALSTATEDIR}/lock',
179 'FHS-PATH': '${LOCALSTATEDIR}/lock/samba',
180 'OPTION': '--with-lockdir',
181 'HELPTEXT': 'Where to put short term disposable state files',
184 'STD-PATH': '${LOCALSTATEDIR}/run',
185 'FHS-PATH': '${LOCALSTATEDIR}/run/samba',
186 'OPTION': '--with-piddir',
187 'HELPTEXT': 'Where to put pid files',
190 'STD-PATH': '${LOCALSTATEDIR}/locks',
191 'FHS-PATH': '${LOCALSTATEDIR}/lib/samba',
192 'OPTION': '--with-statedir',
193 'HELPTEXT': 'Where to put persistent state files',
196 'STD-PATH': '${LOCALSTATEDIR}/cache',
197 'FHS-PATH': '${LOCALSTATEDIR}/cache/samba',
198 'OPTION': '--with-cachedir',
199 'HELPTEXT': 'Where to put temporary cache files',
202 'STD-PATH': '${LOCALSTATEDIR}',
203 'FHS-PATH': '${LOCALSTATEDIR}/log/samba',
204 'OPTION': '--with-logfilebase',
205 'HELPTEXT': 'Where to put log files',
208 'STD-PATH': '${LOCALSTATEDIR}/run',
209 'FHS-PATH': '${LOCALSTATEDIR}/run/samba',
210 'OPTION': '--with-sockets-dir',
211 'HELPTEXT': 'socket directory',
213 'PRIVILEGED_SOCKET_DIR' : {
214 'STD-PATH': '${LOCALSTATEDIR}/lib',
215 'FHS-PATH': '${LOCALSTATEDIR}/lib/samba',
216 'OPTION': '--with-privileged-socket-dir',
217 'HELPTEXT': 'privileged socket directory',
219 'WINBINDD_SOCKET_DIR' : {
220 'STD-PATH': '${SOCKET_DIR}/winbindd',
221 'FHS-PATH': '${SOCKET_DIR}/winbindd',
224 'WINBINDD_PRIVILEGED_SOCKET_DIR' : {
225 'STD-PATH': '${PRIVILEGED_SOCKET_DIR}/winbindd_privileged',
226 'FHS-PATH': '${PRIVILEGED_SOCKET_DIR}/winbindd_privileged',
230 'STD-PATH': '${SOCKET_DIR}/nmbd',
231 'FHS-PATH': '${SOCKET_DIR}/nmbd',
234 'NTP_SIGND_SOCKET_DIR' : {
235 'STD-PATH': '${PRIVILEGED_SOCKET_DIR}/ntp_signd',
236 'FHS-PATH': '${PRIVILEGED_SOCKET_DIR}/ntp_signd',
240 'STD-PATH': '${SOCKET_DIR}/ncalrpc',
241 'FHS-PATH': '${SOCKET_DIR}/ncalrpc',
245 'STD-PATH': '${CONFIGDIR}/smb.conf',
246 'FHS-PATH': '${CONFIGDIR}/smb.conf',
250 'STD-PATH': '${CONFIGDIR}/lmhosts',
251 'FHS-PATH': '${CONFIGDIR}/lmhosts',
254 'SMB_PASSWD_FILE' : {
255 'STD-PATH': '${PRIVATE_DIR}/smbpasswd',
256 'FHS-PATH': '${PRIVATE_DIR}/smbpasswd',
257 'OPTION': '--with-smbpasswd-file',
258 'HELPTEXT': 'Where to put the smbpasswd file',
263 def set_options(opt):
264 opt.parser.formatter = SambaIndentedHelpFormatter()
265 opt.parser.formatter.width=Utils.get_term_cols()
267 for k in ('--with-privatelibdir', '--with-modulesdir'):
268 option = opt.parser.get_option(k)
270 opt.parser.remove_option(k)
271 del opt.parser.defaults['PRIVATELIBDIR']
272 del opt.parser.defaults['MODULESDIR']
274 # get all the basic GNU options from the gnu_dirs tool
276 opt_group=opt.add_option_group('Samba-specific directory layout','')
278 fhs_help = "Use FHS-compliant paths (default no)\n"
279 fhs_help += "You should consider using this together with:\n"
280 fhs_help += "--prefix=/usr --sysconfdir=/etc --localstatedir=/var"
281 opt_group.add_option('--enable-fhs', help=fhs_help,
282 action="store_true", dest='ENABLE_FHS', default=False)
284 for varname in dynconfig.keys():
285 if 'OPTION' not in dynconfig[varname]:
287 opt = dynconfig[varname]['OPTION']
288 if 'HELPTEXT' in dynconfig[varname]:
289 txt = dynconfig[varname]['HELPTEXT']
291 txt = "dynconfig path %s" % (varname)
292 def_std = dynconfig[varname]['STD-PATH']
293 def_fhs = dynconfig[varname]['FHS-PATH']
295 help = "%s\n[STD-Default: %s]\n[FHS-Default: %s]" % (txt, def_std, def_fhs)
296 opt_group.add_option(opt, help=help, dest=varname, action="store")
299 # get all the basic GNU options from the gnu_dirs tool
301 if Options.options.ENABLE_FHS:
305 if conf.env.PREFIX == '/usr' or conf.env.PREFIX == '/usr/local':
306 Logs.error("Don't install directly under /usr or /usr/local without using the FHS option (--enable-fhs)")
307 raise Utils.WafError("ERROR: invalid --prefix=%s value" % (conf.env.PREFIX))
312 for varname in dynconfig.keys():
313 dyn_vars[varname] = dynconfig[varname][flavor]
314 if 'OVERWRITE' in dynconfig[varname] and dynconfig[varname]['OVERWRITE']:
315 # we may overwrite this option
317 conf.ASSERT(varname not in conf.env, "Variable %s already defined" % varname)
320 for varname in dynconfig.keys():
321 if 'OPTION' not in dynconfig[varname]:
323 value = getattr(Options.options, varname, None)
326 conf.ASSERT(value != '', "Empty dynconfig value for %s" % varname)
327 conf.env[varname] = value
328 # mark it as explicit from the command line
329 explicit_set[varname] = value
331 # defaults stage 1 after the explicit block
332 for varname in dynconfig.keys():
333 if 'DELAY' in dynconfig[varname] and dynconfig[varname]['DELAY']:
334 # this option referrs to other options,
335 # so it needs to wait for stage 2.
337 value = EXPAND_VARIABLES(conf, dyn_vars[varname])
338 conf.ASSERT(value != '', "Empty dynconfig value for %s" % varname)
339 if varname not in explicit_set:
340 # only overwrite if not specified explicitly on the command line
341 conf.env[varname] = value
343 # defaults stage 2 after the explicit block
344 for varname in dynconfig.keys():
345 if 'DELAY' not in dynconfig[varname] or not dynconfig[varname]['DELAY']:
346 # this option was already handled in stage 1.
348 value = EXPAND_VARIABLES(conf, dyn_vars[varname])
349 conf.ASSERT(value != '', "Empty dynconfig value for %s" % varname)
350 if varname not in explicit_set:
351 # only overwrite if not specified explicitly on the command line
352 conf.env[varname] = value
354 # display the expanded pathes for the user
355 for varname in dynconfig.keys():
356 value = conf.env[varname]
357 conf.start_msg("Dynconfig[%s]: " % (varname))
358 conf.end_msg("'%s'" % (value), 'GREEN')
360 def get_override(bld):
361 override = { 'MODULESDIR' : 'bin/modules',
362 'PYTHONDIR' : 'bin/python',
363 'PYTHONARCHDIR' : 'bin/python',
366 'CODEPAGEDIR' : 'codepages',
367 'SCRIPTSBINDIR' : 'source4/scripting/bin',
368 'SETUPDIR' : 'source4/setup'
372 def dynconfig_cflags(bld, list=None):
373 '''work out the extra CFLAGS for dynconfig.c'''
375 for varname in dynconfig.keys():
376 if list and not varname in list:
378 value = bld.env[varname]
379 if not bld.is_install:
380 override = get_override(bld)
381 if varname in override:
382 value = os.path.join(bld.env.srcdir, override[varname])
383 cflags.append('-D%s="%s"' % (varname, value))
385 Build.BuildContext.dynconfig_cflags = dynconfig_cflags
387 def dynconfig_varnames(bld, list=None):
388 '''work out the dynconfig variables'''
390 for varname in dynconfig.keys():
391 if list and not varname in list:
393 varnames.append(varname)
395 Build.BuildContext.dynconfig_varnames = dynconfig_varnames
397 def pathconfig_entities(bld, list=None):
398 '''work out the extra entities for the docs'''
400 for varname in dynconfig.keys():
401 if list and not varname in list:
403 value = bld.env[varname]
404 if not bld.is_install:
405 override = get_override(bld)
406 if varname in override:
407 value = os.path.join(bld.env.srcdir, override[varname])
408 entities.append("<!ENTITY pathconfig.%s '%s'>" % (varname, value))
410 Build.BuildContext.pathconfig_entities = pathconfig_entities
413 cflags = bld.dynconfig_cflags()
414 version_header = 'version.h'
415 bld.SAMBA_SUBSYSTEM('DYNCONFIG',
418 public_headers=os_path_relpath(os.path.join(Options.launch_dir, version_header), bld.curdir),
422 # install some extra empty directories
423 bld.INSTALL_DIRS("", "${CONFIGDIR} ${PRIVATE_DIR} ${LOGFILEBASE}");
424 bld.INSTALL_DIRS("", "${PRIVATE_DIR} ${PRIVILEGED_SOCKET_DIR}")
425 bld.INSTALL_DIRS("", "${STATEDIR} ${CACHEDIR}");
427 # these might be on non persistent storage
428 bld.INSTALL_DIRS("", "${LOCKDIR} ${PIDDIR} ${SOCKET_DIR}")