dynconfig: add SambaIndentedHelpFormatter in order to support \n in option help text
[kai/samba-autobuild/.git] / dynconfig / wscript
index d6b07efb5ddb4c5e45171cf72df9ed503be19a9d..ba1809dd953e450292a25b980d25b00405ecb3f6 100755 (executable)
@@ -1,19 +1,66 @@
 #!/usr/bin/env python
 
-import string, Utils, Options, sys, Build, os, intltool
+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'                         : [ '${LOCALSTATEDIR}/run', 'where to put pid files' ],
+    'with-piddir'                         : [ '${PREFIX}/var/run', 'where to put pid files' ],
     'with-privatedir'                     : [ '${PREFIX}/private', 'Where to put sam.ldb and other private files' ],
-    'with-sockets-dir'                    : [ '${LOCALSTATEDIR}/run', 'sockets directory' ],
-    'with-winbindd-privileged-socket-dir' : [ '${LOCALSTATEDIR}/lib/winbindd_privileged', 'winbind privileged socket directory'],
-    'with-lockdir'                        : [ '${LOCALSTATEDIR}/lock', 'where to put short term disposable state files' ],
-    'with-cachedir'                       : [ '${LOCALSTATEDIR}/cache', 'where to put cache files' ],
-    'with-logfilebase'                    : [ '${LOCALSTATEDIR}', 'Where to put log files' ],
-    'with-pammodulesdir'                  : [ '${LIBDIR}', 'Which directory to use for PAM modules' ],
-    'with-statedir'                       : [ '${LOCALSTATEDIR}/locks', 'where to put persistent state 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
@@ -25,30 +72,56 @@ dyn_cflags = {
     'CONFIGFILE'                     : '${SYSCONFDIR}/smb.conf',
     'LMHOSTSFILE'                    : '${SYSCONFDIR}/lmhosts',
     'PRIVATE_DIR'                    : '${PRIVATEDIR}',
-    'LOGFILEBASE'                    : '${LOGFILEBASE}',
-    'LOCKDIR'                        : '${LOCKDIR}',
-    'PIDDIR'                         : '${PIDDIR}',
+    'LOGFILEBASE'                    : '${LOCALSTATEDIR}',
+    'LOCKDIR'                        : '${LOCALSTATEDIR}/locks',
+    'PIDDIR'                         : '${LOCALSTATEDIR}/run',
     'DATADIR'                        : '${DATADIR}',
     'LOCALEDIR'                      : '${LOCALEDIR}',
     'SETUPDIR'                       : '${DATADIR}/setup',
-    'WINBINDD_SOCKET_DIR'            : '${SOCKETS_DIR}/winbindd',
+    'WINBINDD_SOCKET_DIR'            : '${WINBINDD_SOCKET_DIR}',
     'WINBINDD_PRIVILEGED_SOCKET_DIR' : '${WINBINDD_PRIVILEGED_SOCKET_DIR}',
-    'NTP_SIGND_SOCKET_DIR'           : '${SOCKETS_DIR}/ntp_signd',
-    'NCALRPCDIR'                     : '${SOCKETS_DIR}/ncalrpc',
+    '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'                    : '${DATADIR}/codepages',
+    'CODEPAGEDIR'                    : '${LIBDIR}/samba',
     'LIBDIR'                         : '${LIBDIR}',
-    'LIBEXECDIR'                     : '${LIBEXECDIR}',
-    'STATEDIR'                       : '${STATEDIR}',
-    'CACHEDIR'                       : '${CACHEDIR}',
+    'LIBEXECDIR'                     : '${MODULESDIR}',
+    'STATEDIR'                       : '${LOCALSTATEDIR}',
+    'CACHEDIR'                       : '${LOCKDIR}',
     'SMB_PASSWD_FILE'                : '${PRIVATEDIR}/smbpasswd',
-    'NMBDSOCKETDIR'                  : '${SOCKETS_DIR}/nmbd',
-    'PAMMODULESDIR'                  : '${PAMMODULESDIR}',
+    '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):
@@ -62,27 +135,55 @@ def get_varname(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.add_option('--%s' % 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)
-        conf.env[f] = v
+        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'''