samba-mirror/dynconfig/wscript

#!/usr/bin/env python

import string, Utils, Options, sys, Build, os, intltool, optparse, textwrap
from samba_utils import EXPAND_VARIABLES, os_path_relpath

class SambaIndentedHelpFormatter (optparse.IndentedHelpFormatter):
    """Format help with indented section bodies.
    """

    def __init__(self,
                 indent_increment=2,
                 max_help_position=12,
                 width=None,
                 short_first=1):
        optparse.IndentedHelpFormatter.__init__(
            self, indent_increment, max_help_position, width, short_first)

    def format_option(self, option):
        # The help for each option consists of two parts:
        #   * the opt strings and metavars
        #     eg. ("-x", or "-fFILENAME, --file=FILENAME")
        #   * the user-supplied help string
        #     eg. ("turn on expert mode", "read data from FILENAME")
        #
        # If possible, we write both of these on the same line:
        #   -x      turn on expert mode
        #
        # But if the opt string list is too long, we put the help
        # string on a second line, indented to the same column it would
        # start in if it fit on the first line.
        #   -fFILENAME, --file=FILENAME
        #           read data from FILENAME
        result = []
        opts = self.option_strings[option]
        opt_width = self.help_position - self.current_indent - 2
        if len(opts) > opt_width:
            opts = "%*s%s\n" % (self.current_indent, "", opts)
            indent_first = self.help_position
        else:                       # start help on same line as opts
            opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
            indent_first = 0
        result.append(opts)
        if option.help:
            help_text = self.expand_default(option)
            if string.find(help_text, '\n') == -1:
                help_lines = textwrap.wrap(help_text, self.help_width)
            else:
                help_lines = help_text.splitlines()
            result.append("%*s%s\n" % (indent_first, "", help_lines[0]))
            result.extend(["%*s%s\n" % (self.help_position, "", line)
                           for line in help_lines[1:]])
        elif opts[-1] != "\n":
            result.append("\n")
        return "".join(result)

# list of directory options to offer in configure
dir_options = {
    'with-piddir'                         : [ '${PREFIX}/var/run', 'where to put pid files' ],
    'with-privatedir'                     : [ '${PREFIX}/private', 'Where to put sam.ldb and other private files' ],
    'with-winbindd-socket-dir'            : [ '${PREFIX}/var/lib/winbindd', 'winbind socket directory' ],
    'with-winbindd-privileged-socket-dir' : [ '${PREFIX}/var/lib/winbindd_privileged', 'winbind privileged socket directory'],
    'with-ntp-signd-socket-dir'           : [ '${PREFIX}/var/run/ntp_signd', 'NTP signed directory'],
    'with-lockdir'                        : [ '${PREFIX}/var/locks', 'where to put lock files' ]
    }

# list of cflags to use for dynconfig.c
dyn_cflags = {
    'BINDIR'                         : '${BINDIR}',
    'SBINDIR'                        : '${SBINDIR}',
    'SCRIPTSBINDIR'                  : '${SBINDIR}',
    'CONFIGDIR'                      : '${SYSCONFDIR}',
    'CONFIGFILE'                     : '${SYSCONFDIR}/smb.conf',
    'LMHOSTSFILE'                    : '${SYSCONFDIR}/lmhosts',
    'PRIVATE_DIR'                    : '${PRIVATEDIR}',
    'LOGFILEBASE'                    : '${LOCALSTATEDIR}',
    'LOCKDIR'                        : '${LOCALSTATEDIR}/locks',
    'PIDDIR'                         : '${LOCALSTATEDIR}/run',
    'DATADIR'                        : '${DATADIR}',
    'LOCALEDIR'                      : '${LOCALEDIR}',
    'SETUPDIR'                       : '${DATADIR}/setup',
    'WINBINDD_SOCKET_DIR'            : '${WINBINDD_SOCKET_DIR}',
    'WINBINDD_PRIVILEGED_SOCKET_DIR' : '${WINBINDD_PRIVILEGED_SOCKET_DIR}',
    'NTP_SIGND_SOCKET_DIR'           : '${NTP_SIGND_SOCKET_DIR}',
    'NCALRPCDIR'                     : '${LOCALSTATEDIR}/ncalrpc',
    'PYTHONDIR'                      : '${PYTHONDIR}',
    'PYTHONARCHDIR'                  : '${PYTHONARCHDIR}',
    'MODULESDIR'                     : '${PREFIX}/modules',
    'INCLUDEDIR'                     : '${PREFIX}/include',
    'PKGCONFIGDIR'                   : '${LIBDIR}/pkgconfig',
    'SWATDIR'                        : '${DATADIR}/swat',
    'CODEPAGEDIR'                    : '${LIBDIR}/samba',
    'LIBDIR'                         : '${LIBDIR}',
    'LIBEXECDIR'                     : '${MODULESDIR}',
    'STATEDIR'                       : '${LOCALSTATEDIR}',
    'CACHEDIR'                       : '${LOCKDIR}',
    'SMB_PASSWD_FILE'                : '${PRIVATEDIR}/smbpasswd',
    'NMBDSOCKETDIR'                  : '${LOCALSTATEDIR}/nmbd',
    }

# changes for when FHS is enabled
dyn_cflags_fhs = {
    'BINDIR'                         : '${BINDIR}',
    'SBINDIR'                        : '${SBINDIR}',
    'SCRIPTSBINDIR'                  : '${SBINDIR}',
    'CONFIGDIR'                      : '${SYSCONFDIR}/samba',
    'CONFIGFILE'                     : '${SYSCONFDIR}/samba/smb.conf',
    'LMHOSTSFILE'                    : '${SYSCONFDIR}/samba/lmhosts',
    'PRIVATE_DIR'                    : '${LOCALSTATEDIR}/lib/samba/private',
    'LOGFILEBASE'                    : '${LOCALSTATEDIR}/log/samba',
    'LOCKDIR'                        : '${LOCALSTATEDIR}/lib/samba',
    'PIDDIR'                         : '${LOCALSTATEDIR}/run/samba',
    'SETUPDIR'                       : '${DATADIR}/samba/setup',
    'WINBINDD_SOCKET_DIR'            : '${LOCALSTATEDIR}/run/samba/winbindd',
    'WINBINDD_PRIVILEGED_SOCKET_DIR' : '${LOCALSTATEDIR}/run/samba/winbindd_privileged',
    'NTP_SIGND_SOCKET_DIR'           : '${LOCALSTATEDIR}/run/samba/ntp_signd',
    'NCALRPCDIR'                     : '${LOCALSTATEDIR}/run/samba/ncalrpc',
    'PYTHONARCHDIR'                  : '${PYTHONARCHDIR}',
    'MODULESDIR'                     : '${LIBDIR}/samba',
    'LIBEXECDIR'                     : '${MODULESDIR}',
    'INCLUDEDIR'                     : '${INCLUDEDIR}/samba-4.0',
    'PKGCONFIGDIR'                   : '${LIBDIR}/pkgconfig',
    'SWATDIR'                        : '${DATADIR}/swat',
    'CODEPAGEDIR'                    : '${DATADIR}/samba',
    'NMBDSOCKETDIR'                  : '${LOCALSTATEDIR}/run/samba/nmbd',
    }

def get_varname(v):
    '''work out a variable name from a configure option name'''
    if v.startswith('with-'):
        v = v[5:]
    v = v.upper()
    v = v.replace('-', '_')
    return v


def set_options(opt):
    # get all the basic GNU options from the gnu_dirs tool
    opt.parser.formatter = SambaIndentedHelpFormatter()
    opt.parser.formatter.width=Utils.get_term_cols()

    opt_group=opt.add_option_group('Samba-specific directory layout','')

    opt_group.add_option('--enable-fhs',
                   help=("Use FHS-compliant paths (default no)"),
                   action="store_true", dest='ENABLE_FHS', default=False)
    for option in dir_options.keys():
        default = dir_options[option][0]
        help    = dir_options[option][1]
        varname = get_varname(option)
        opt_group.add_option('--%s' % option,
                       help=(help + ' [%s]' % default),
                       action="store", dest=varname, default=default)

def configure(conf):
    # get all the basic GNU options from the gnu_dirs tool

    explicit_set = {}

    for option in dir_options.keys():
        default = dir_options[option][0]
        varname = get_varname(option)
        value = getattr(Options.options, varname, None)
        conf.ASSERT(value is not None, "Missing configure option %s" % varname)
        conf.ASSERT(varname not in conf.env, "Variable %s already defined" % varname)
        conf.env[varname] = value
        if value is not default:
            explicit_set[varname] = "%s:%s" % (default, value)

    for f in dyn_cflags.keys():
        v = EXPAND_VARIABLES(conf, dyn_cflags[f])
        conf.ASSERT(v != '', "Empty dynconfig value for %s" % f)
        if f not in explicit_set:
            conf.env[f] = v

    if Options.options.ENABLE_FHS:
        for f in dyn_cflags_fhs.keys():
            v = EXPAND_VARIABLES(conf, dyn_cflags_fhs[f])
            conf.ASSERT(v != '', "Empty dynconfig value for %s" % f)
            if f not in explicit_set:
                conf.env[f] = v

    if (not Options.options.ENABLE_FHS and
        (conf.env.PREFIX == '/usr' or conf.env.PREFIX == '/usr/local')):
        print("ERROR: Don't install directly under /usr or /usr/local without using the FHS option (--enable-fhs)")
        sys.exit(1)


def dynconfig_cflags(bld, list=None):
    '''work out the extra CFLAGS for dynconfig.c'''
    cflags = []
    # override some paths when running from the build directory
    override = { 'MODULESDIR'    : 'bin/modules',
                 'PYTHONDIR'     : 'bin/python',
                 'PYTHONARCHDIR' : 'bin/python',
                 'CODEPAGEDIR'   : os.path.join(bld.env.srcdir, 'codepages'),
                 'SCRIPTSBINDIR' : os.path.join(bld.env.srcdir, 'source4/scripting/bin'),
                 'SETUPDIR'      : os.path.join(bld.env.srcdir, 'source4/setup') }
    for f in dyn_cflags.keys():
        if list and not f in list:
            continue
        value = bld.env[f]
        if not Options.is_install:
            if f in override:
                value = os.path.join(os.getcwd(), override[f])
        cflags.append('-D%s="%s"' % (f, value))
    return cflags
Build.BuildContext.dynconfig_cflags = dynconfig_cflags

def build(bld):
    cflags = bld.dynconfig_cflags()
    version_header = 'version.h'
    if not os.getenv('TOPLEVEL_BUILD'):
        version_header = 'include/version.h'
    bld.SAMBA_SUBSYSTEM('DYNCONFIG',
                        'dynconfig.c',
                        deps='replace talloc',
                        public_headers=os_path_relpath(os.path.join(Options.launch_dir, version_header), bld.curdir),
                        header_path='samba',
                        cflags=cflags)