dynconfig/wscript

   1 #!/usr/bin/env python
   2
   3 import string, Logs, Utils, Options, Build, os, optparse, textwrap
   4 from samba_utils import EXPAND_VARIABLES, os_path_relpath
   5
   6 class SambaIndentedHelpFormatter (optparse.IndentedHelpFormatter):
   7     """Format help with indented section bodies.
   8     """
   9
  10     def __init__(self,
  11                  indent_increment=2,
  12                  max_help_position=12,
  13                  width=None,
  14                  short_first=1):
  15         optparse.IndentedHelpFormatter.__init__(
  16             self, indent_increment, max_help_position, width, short_first)
  17
  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")
  24         #
  25         # If possible, we write both of these on the same line:
  26         #   -x      turn on expert mode
  27         #
  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
  33         result = []
  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)
  41             indent_first = 0
  42         result.append(opts)
  43         if option.help:
  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)
  47             else:
  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":
  53             result.append("\n")
  54         return "".join(result)
  55
  56
  57 # list of directory options to offer in configure
  58 #
  59 # 'STD-PATH'  - the default path without --enable-fhs
  60 # 'FHS-PATH'  - the default path with --enable-fhs
  61 #
  62 # 'OPTION'    - the configure option to overwrite the default (optional)
  63 # 'HELPTEXT'  - the help text of the configure option (optional)
  64 #
  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)
  68 #
  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)
  72 #
  73 dynconfig = {
  74     'BINDIR' : {
  75          'STD-PATH':  '${BINDIR}',
  76          'FHS-PATH':  '${BINDIR}',
  77          'OVERWRITE': True,
  78     },
  79     'SBINDIR' : {
  80          'STD-PATH':  '${SBINDIR}',
  81          'FHS-PATH':  '${SBINDIR}',
  82          'OVERWRITE': True,
  83     },
  84     'LIBDIR' : {
  85          'STD-PATH':  '${LIBDIR}',
  86          'FHS-PATH':  '${LIBDIR}',
  87          'OVERWRITE': True,
  88     },
  89     'LIBEXECDIR' : {
  90          'STD-PATH':  '${LIBEXECDIR}',
  91          'FHS-PATH':  '${LIBEXECDIR}',
  92          'OVERWRITE': True,
  93     },
  94     'DATADIR' : {
  95          'STD-PATH':  '${DATADIR}',
  96          'FHS-PATH':  '${DATADIR}',
  97          'OVERWRITE': True,
  98     },
  99     'LOCALEDIR' : {
 100          'STD-PATH':  '${LOCALEDIR}',
 101          'FHS-PATH':  '${LOCALEDIR}',
 102          'OVERWRITE': True,
 103     },
 104     'PYTHONDIR' : {
 105          'STD-PATH':  '${PYTHONDIR}',
 106          'FHS-PATH':  '${PYTHONDIR}',
 107          'OVERWRITE': True,
 108     },
 109     'PYTHONARCHDIR' : {
 110          'STD-PATH':  '${PYTHONARCHDIR}',
 111          'FHS-PATH':  '${PYTHONARCHDIR}',
 112          'OVERWRITE': True,
 113     },
 114     'PERL_LIB_INSTALL_DIR' : {
 115          'STD-PATH':  '${PERL_LIB_INSTALL_DIR}',
 116          'FHS-PATH':  '${PERL_LIB_INSTALL_DIR}',
 117          'OVERWRITE': True,
 118     },
 119     'PERL_ARCH_INSTALL_DIR' : {
 120          'STD-PATH':  '${PERL_ARCH_INSTALL_DIR}',
 121          'FHS-PATH':  '${PERL_ARCH_INSTALL_DIR}',
 122          'OVERWRITE': True,
 123     },
 124     'INCLUDEDIR' : {
 125          'STD-PATH':  '${INCLUDEDIR}',
 126          'FHS-PATH':  '${INCLUDEDIR}/samba-4.0',
 127          'OVERWRITE': True,
 128     },
 129     'SCRIPTSBINDIR' : {
 130          'STD-PATH':  '${SBINDIR}',
 131          'FHS-PATH':  '${SBINDIR}',
 132     },
 133     'SETUPDIR' : {
 134          'STD-PATH':  '${DATADIR}/setup',
 135          'FHS-PATH':  '${DATADIR}/samba/setup',
 136     },
 137     'PKGCONFIGDIR' : {
 138          'STD-PATH':  '${LIBDIR}/pkgconfig',
 139          'FHS-PATH':  '${LIBDIR}/pkgconfig',
 140     },
 141     'CODEPAGEDIR' : {
 142          'STD-PATH':  '${DATADIR}/codepages',
 143          'FHS-PATH':  '${DATADIR}/samba/codepages',
 144     },
 145     'PRIVATELIBDIR' : {
 146          'STD-PATH':  '${LIBDIR}/private',
 147          'FHS-PATH':  '${LIBDIR}/samba',
 148          'OPTION':    '--with-privatelibdir',
 149          'HELPTEXT':  'Which directory to use for private Samba libraries',
 150          'OVERWRITE': True,
 151     },
 152     'MODULESDIR' : {
 153          'STD-PATH':  '${LIBDIR}',
 154          'FHS-PATH':  '${LIBDIR}/samba',
 155          'OPTION':    '--with-modulesdir',
 156          'HELPTEXT':  'Which directory to use for Samba modules',
 157          'OVERWRITE': True,
 158     },
 159     'PAMMODULESDIR' : {
 160          'STD-PATH':  '${LIBDIR}/security',
 161          'FHS-PATH':  '${LIBDIR}/security',
 162          'OPTION':    '--with-pammodulesdir',
 163          'HELPTEXT':  'Which directory to use for PAM modules',
 164     },
 165     'CONFIGDIR' : {
 166          'STD-PATH':  '${SYSCONFDIR}',
 167          'FHS-PATH':  '${SYSCONFDIR}/samba',
 168          'OPTION':    '--with-configdir',
 169          'HELPTEXT':  'Where to put configuration files',
 170     },
 171     'PRIVATE_DIR' : {
 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',
 176     },
 177     'LOCKDIR' : {
 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',
 182     },
 183     'PIDDIR' : {
 184          'STD-PATH':  '${LOCALSTATEDIR}/run',
 185          'FHS-PATH':  '${LOCALSTATEDIR}/run/samba',
 186          'OPTION':    '--with-piddir',
 187          'HELPTEXT':  'Where to put pid files',
 188     },
 189     'STATEDIR' : {
 190          'STD-PATH':  '${LOCALSTATEDIR}/locks',
 191          'FHS-PATH':  '${LOCALSTATEDIR}/lib/samba',
 192          'OPTION':    '--with-statedir',
 193          'HELPTEXT':  'Where to put persistent state files',
 194     },
 195     'CACHEDIR' : {
 196          'STD-PATH':  '${LOCALSTATEDIR}/cache',
 197          'FHS-PATH':  '${LOCALSTATEDIR}/cache/samba',
 198          'OPTION':    '--with-cachedir',
 199          'HELPTEXT':  'Where to put temporary cache files',
 200     },
 201     'LOGFILEBASE' : {
 202          'STD-PATH':  '${LOCALSTATEDIR}',
 203          'FHS-PATH':  '${LOCALSTATEDIR}/log/samba',
 204          'OPTION':    '--with-logfilebase',
 205          'HELPTEXT':  'Where to put log files',
 206     },
 207     'SOCKET_DIR' : {
 208          'STD-PATH':  '${LOCALSTATEDIR}/run',
 209          'FHS-PATH':  '${LOCALSTATEDIR}/run/samba',
 210          'OPTION':    '--with-sockets-dir',
 211          'HELPTEXT':  'socket directory',
 212     },
 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',
 218     },
 219     'WINBINDD_SOCKET_DIR' : {
 220          'STD-PATH':  '${SOCKET_DIR}/winbindd',
 221          'FHS-PATH':  '${SOCKET_DIR}/winbindd',
 222          'DELAY':     True,
 223     },
 224     'WINBINDD_PRIVILEGED_SOCKET_DIR' : {
 225          'STD-PATH':  '${PRIVILEGED_SOCKET_DIR}/winbindd_privileged',
 226          'FHS-PATH':  '${PRIVILEGED_SOCKET_DIR}/winbindd_privileged',
 227          'DELAY':     True,
 228     },
 229     'NMBDSOCKETDIR' : {
 230          'STD-PATH':  '${SOCKET_DIR}/nmbd',
 231          'FHS-PATH':  '${SOCKET_DIR}/nmbd',
 232          'DELAY':     True,
 233     },
 234     'NTP_SIGND_SOCKET_DIR' : {
 235          'STD-PATH':  '${PRIVILEGED_SOCKET_DIR}/ntp_signd',
 236          'FHS-PATH':  '${PRIVILEGED_SOCKET_DIR}/ntp_signd',
 237          'DELAY':     True,
 238     },
 239     'NCALRPCDIR' : {
 240          'STD-PATH':  '${SOCKET_DIR}/ncalrpc',
 241          'FHS-PATH':  '${SOCKET_DIR}/ncalrpc',
 242          'DELAY':     True,
 243     },
 244     'CONFIGFILE' : {
 245          'STD-PATH':  '${CONFIGDIR}/smb.conf',
 246          'FHS-PATH':  '${CONFIGDIR}/smb.conf',
 247          'DELAY':     True,
 248     },
 249     'LMHOSTSFILE' : {
 250          'STD-PATH':  '${CONFIGDIR}/lmhosts',
 251          'FHS-PATH':  '${CONFIGDIR}/lmhosts',
 252          'DELAY':     True,
 253     },
 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',
 259          'DELAY':     True,
 260     },
 261 }
 262
 263 def set_options(opt):
 264     opt.parser.formatter = SambaIndentedHelpFormatter()
 265     opt.parser.formatter.width=Utils.get_term_cols()
 266
 267     for k in ('--with-privatelibdir', '--with-modulesdir'):
 268         option = opt.parser.get_option(k)
 269         if option:
 270             opt.parser.remove_option(k)
 271     del opt.parser.defaults['PRIVATELIBDIR']
 272     del opt.parser.defaults['MODULESDIR']
 273
 274     # get all the basic GNU options from the gnu_dirs tool
 275
 276     opt_group=opt.add_option_group('Samba-specific directory layout','')
 277
 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)
 283
 284     for varname in dynconfig.keys():
 285         if 'OPTION' not in dynconfig[varname]:
 286             continue
 287         opt = dynconfig[varname]['OPTION']
 288         if 'HELPTEXT' in dynconfig[varname]:
 289             txt = dynconfig[varname]['HELPTEXT']
 290         else:
 291             txt = "dynconfig path %s" % (varname)
 292         def_std = dynconfig[varname]['STD-PATH']
 293         def_fhs = dynconfig[varname]['FHS-PATH']
 294
 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")
 297
 298 def configure(conf):
 299     # get all the basic GNU options from the gnu_dirs tool
 300
 301     if Options.options.ENABLE_FHS:
 302         flavor = 'FHS-PATH'
 303     else:
 304         flavor = 'STD-PATH'
 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))
 308
 309     explicit_set ={}
 310
 311     dyn_vars = {}
 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
 316             continue
 317         conf.ASSERT(varname not in conf.env, "Variable %s already defined" % varname)
 318
 319     # the explicit block
 320     for varname in dynconfig.keys():
 321         if 'OPTION' not in dynconfig[varname]:
 322             continue
 323         value = getattr(Options.options, varname, None)
 324         if value is None:
 325            continue
 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
 330
 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.
 336             continue
 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
 342
 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.
 347             continue
 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
 353
 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')
 359
 360 def get_override(bld):
 361     override = { 'MODULESDIR'    : 'bin/modules',
 362                  'PYTHONDIR'     : 'bin/python',
 363                  'PYTHONARCHDIR' : 'bin/python',
 364                  'BINDIR'        : 'bin',
 365                  'SBINDIR'       : 'bin',
 366                  'CODEPAGEDIR'   : 'codepages',
 367                  'SCRIPTSBINDIR' : 'source4/scripting/bin',
 368                  'SETUPDIR'      : 'source4/setup'
 369                  }
 370     return override
 371
 372 def dynconfig_cflags(bld, list=None):
 373     '''work out the extra CFLAGS for dynconfig.c'''
 374     cflags = []
 375     for varname in dynconfig.keys():
 376         if list and not varname in list:
 377             continue
 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))
 384     return cflags
 385 Build.BuildContext.dynconfig_cflags = dynconfig_cflags
 386
 387 def dynconfig_varnames(bld, list=None):
 388     '''work out the dynconfig variables'''
 389     varnames = []
 390     for varname in dynconfig.keys():
 391         if list and not varname in list:
 392             continue
 393         varnames.append(varname)
 394     return varnames
 395 Build.BuildContext.dynconfig_varnames = dynconfig_varnames
 396
 397 def pathconfig_entities(bld, list=None):
 398     '''work out the extra entities for the docs'''
 399     entities = []
 400     for varname in dynconfig.keys():
 401         if list and not varname in list:
 402             continue
 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))
 409     return entities
 410 Build.BuildContext.pathconfig_entities = pathconfig_entities
 411
 412 def build(bld):
 413     cflags = bld.dynconfig_cflags()
 414     version_header = 'version.h'
 415     bld.SAMBA_SUBSYSTEM('DYNCONFIG',
 416                         'dynconfig.c',
 417                         deps='replace',
 418                         public_headers=os_path_relpath(os.path.join(Options.launch_dir, version_header), bld.curdir),
 419                         header_path='samba',
 420                         cflags=cflags)
 421
 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}");
 426
 427     # these might be on non persistent storage
 428     bld.INSTALL_DIRS("", "${LOCKDIR} ${PIDDIR} ${SOCKET_DIR}")