testparm: Convert to Python.

3 files changed, 204 insertions, 266 deletions

diff --git a/source4/scripting/bin/testparm b/source4/scripting/bin/testparm
new file mode 100755
index 0000000000..1162c3b687
--- /dev/null
+++ b/source4/scripting/bin/testparm
@@ -0,0 +1,204 @@
+#!/usr/bin/python
+# vim: expandtab ft=python
+#
+#   Unix SMB/CIFS implementation.
+#   Test validity of smb.conf
+#   Copyright (C) Karl Auer 1993, 1994-1998
+#
+#   Extensively modified by Andrew Tridgell, 1995
+#   Converted to popt by Jelmer Vernooij (jelmer@nl.linux.org), 2002
+#   Updated for Samba4 by Andrew Bartlett <abartlet@samba.org> 2006
+#   Converted to Python by Jelmer Vernooij <jelmer@samba.org> 2010
+#   
+#   This program is free software; you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation; either version 3 of the License, or
+#   (at your option) any later version.
+#   
+#   This program 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 General Public License for more details.
+#   
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Testbed for loadparm.c/params.c
+#
+# This module simply loads a specified configuration file and
+# if successful, dumps it's contents to stdout. Note that the
+# operation is performed with DEBUGLEVEL at 3.
+#
+# Useful for a quick 'syntax check' of a configuration file.
+#
+
+#/***********************************************
+# Here we do a set of 'hard coded' checks for bad
+# configuration settings.
+#************************************************/
+#
+
+import logging
+import optparse
+import os
+import sys
+
+# Find right directory when running from source tree
+sys.path.insert(0, "bin/python")
+
+import samba
+from samba import getopt as options
+
+def do_global_checks(lp, logger):
+    ret = False
+
+    lockdir = lp.get("lockdir")
+
+    if not os.path.isdir(lockdir):
+        logger.error("lock directory %s does not exist", lockdir)
+        ret = True
+
+    piddir = lp.get("pid directory")
+
+    if os.path.isdir(piddir):
+        logger.error("pid directory %s does not exist", piddir)
+        ret = True
+
+    winbind_separator = lp.get("winbind separator")
+
+    if len(winbind_separator) != 1:
+        logger.error("the 'winbind separator' parameter must be a single character.")
+        ret = True
+
+    if winbind_separator == '+':
+        logger.error("'winbind separator = +' might cause problems with group membership.")
+
+    return ret
+
+
+def allow_access(deny_list, allow_list, cname, caddr):
+    raise NotImplementedError(allow_access)
+
+
+def do_share_checks(lp, cname, caddr, silent_mode, show_defaults, section_name,
+        parameter_name, logger):
+    ret = False
+
+    for s in lp.services():
+        if len(s) > 12:
+            logger.warning("You have some share names that are longer than 12 characters. These may not be accessible to some older clients. (Eg. Windows9x, WindowsMe, and not listed in smbclient in Samba 3.0.)")
+            break
+
+    for s in lp.services():
+        deny_list = lp.get("hosts deny", s)
+        allow_list = lp.get("hosts allow", s)
+        if deny_list:
+            for entry in deny_list:
+                if "*" in entry or "?" in entry:
+                    logger.error("Invalid character (* or ?) in hosts deny list (%s) for service %s.", entry, s)
+
+        if allow_list:
+            for entry in allow_list:
+                if "*" in entry or "?" in entry:
+                    logger.error("Invalid character (* or ?) in hosts allow list (%s) for service %s.", entry, s)
+
+    if cname is not None:
+        if not silent_mode:
+            print "Press enter to see a dump of your service definitions\n"
+            sys.stdin.readline()
+        if section_name is not None or parameter_name is not None:
+            if parameter_name is None:
+                lp.dump_service(sys.stdout, section_name, show_defaults)
+            else:
+                lp.dump_parameter(sys.stdout, section_name, parameter_name)
+        else:
+            lp.dump(sys.stdout, show_defaults)
+        return ret
+
+    if cname is not None and caddr is not None:
+        # this is totally ugly, a real `quick' hack
+        for s in lp.services():
+            if (allow_access(lp.get("hosts deny"), lp.get("hosts allow"), cname, caddr) and
+                allow_access(lp.get("hosts deny", s), lp.get("hosts allow", s), cname, caddr)):
+                logger.info("Allow connection from %s (%s) to %s",
+                       cname, caddr, s)
+            else:
+                logger.info("Deny connection from %s (%s) to %s",
+                       cname, caddr, s)
+
+    return ret
+
+
+if __name__ == '__main__':
+    section_name = None
+    parameter_name = None
+    silent_mode = False
+    show_defaults = False
+
+    parser = optparse.OptionParser("testparm [OPTION...] [host-name] [host-ip]")
+    parser.add_option("--section-name", type="string", metavar="SECTION",
+            help="Limit testparm to a named section")
+    parser.add_option("--parameter-name", type="string", metavar="PARAMETER",
+            help="Limit testparm to a named parameter")
+    parser.add_option("--client-name", type="string", metavar="HOSTNAME",
+            help="Client DNS name for 'hosts allow' checking (should match reverse lookup)")
+    parser.add_option("--client-ip", type="string", metavar="IP",
+            help="Client IP address for 'hosts allow' checking")
+    parser.add_option("--suppress-prompt", action="store_true", 
+            help="Suppress prompt for enter")
+    parser.add_option("--verbose", action="store_true", 
+            help="Show default options too")
+    parser.add_option_group(options.VersionOptions(parser))
+    # We need support for smb.conf macros before this will work again 
+    parser.add_option("--server", type="string",
+            help="Set %%L macro to servername")
+    # These are harder to do with the new code structure
+    parser.add_option("--show-all-parameters", action="store_true", 
+            help="Show the parameters, type, possible values")
+
+    sambaopts = options.SambaOptions(parser)
+    parser.add_option_group(sambaopts)
+
+    opts, args = parser.parse_args()
+
+# 
+#    if (show_all_parameters) {
+#        show_parameter_list()
+#        exit(0)
+#    }
+
+    if len(args) > 0:
+        cname = args[0]
+    else:
+        cname = None
+    if len(args) > 1:
+        caddr = args[1]
+    else:
+        caddr = None
+
+    if cname is not None and caddr is None:
+        print "ERROR: For 'hosts allow' check you must specify both a DNS name and an IP address.\n"
+        sys.exit(1)
+
+#   FIXME: We need support for smb.conf macros before this will work again 
+#
+#    if (new_local_machine) {
+#        set_local_machine_name(new_local_machine, True)
+#    }
+
+    lp = sambaopts.get_loadparm()
+
+    # We need this to force the output
+    samba.set_debug_level(2)
+
+    logger = logging.getLogger("testparm")
+
+    print "Loaded smb config files from %s\n" % lp.configfile
+
+    logger.info("Loaded services file OK.")
+
+    do_global_checks(lp, logger)
+    do_share_checks(lp, cname, caddr, silent_mode, show_defaults,
+            section_name, parameter_name, logger)
+
+    sys.exit(0)
diff --git a/source4/utils/testparm.c b/source4/utils/testparm.c
deleted file mode 100644
index c8e07973bc..0000000000
--- a/source4/utils/testparm.c
+++ /dev/null
@@ -1,260 +0,0 @@
-/* 
-   Unix SMB/CIFS implementation.
-   Test validity of smb.conf
-   Copyright (C) Karl Auer 1993, 1994-1998
-
-   Extensively modified by Andrew Tridgell, 1995
-   Converted to popt by Jelmer Vernooij (jelmer@nl.linux.org), 2002
-   Updated for Samba4 by Andrew Bartlett <abartlet@samba.org> 2006
-   
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 3 of the License, or
-   (at your option) any later version.
-   
-   This program 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 General Public License for more details.
-   
-   You should have received a copy of the GNU General Public License
-   along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-/*
- * Testbed for loadparm.c/params.c
- *
- * This module simply loads a specified configuration file and
- * if successful, dumps it's contents to stdout. Note that the
- * operation is performed with DEBUGLEVEL at 3.
- *
- * Useful for a quick 'syntax check' of a configuration file.
- *
- */
-
-#include "includes.h"
-#include "system/filesys.h"
-#include "lib/cmdline/popt_common.h"
-#include "lib/socket/socket.h"
-#include "param/param.h"
-#include "param/loadparm.h"
-
-
-/***********************************************
- Here we do a set of 'hard coded' checks for bad
- configuration settings.
-************************************************/
-
-static int do_global_checks(struct loadparm_context *lp_ctx)
-{
-	int ret = 0;
-
-	if (!directory_exist(lp_lockdir(lp_ctx))) {
-		fprintf(stderr, "ERROR: lock directory %s does not exist\n",
-		       lp_lockdir(lp_ctx));
-		ret = 1;
-	}
-
-	if (!directory_exist(lp_piddir(lp_ctx))) {
-		fprintf(stderr, "ERROR: pid directory %s does not exist\n",
-		       lp_piddir(lp_ctx));
-		ret = 1;
-	}
-
-	if (strlen(lp_winbind_separator(lp_ctx)) != 1) {
-		fprintf(stderr,"ERROR: the 'winbind separator' parameter must be a single character.\n");
-		ret = 1;
-	}
-
-	if (*lp_winbind_separator(lp_ctx) == '+') {
-		fprintf(stderr,"'winbind separator = +' might cause problems with group membership.\n");
-	}
-
-	return ret;
-}   
-
-
-static int do_share_checks(struct loadparm_context *lp_ctx, const char *cname, const char *caddr, bool silent_mode,
-			   bool show_defaults, const char *section_name, const char *parameter_name)
-{
-	int ret = 0;
-	int s;
-
-	for (s=0;s<lp_numservices(lp_ctx);s++) {
-		struct loadparm_service *service = lp_servicebynum(lp_ctx, s);
-		if (service != NULL)
-			if (strlen(lp_servicename(lp_servicebynum(lp_ctx, s))) > 12) {
-				fprintf(stderr, "WARNING: You have some share names that are longer than 12 characters.\n" );
-				fprintf(stderr, "These may not be accessible to some older clients.\n" );
-				fprintf(stderr, "(Eg. Windows9x, WindowsMe, and not listed in smbclient in Samba 3.0.)\n" );
-				break;
-			}
-	}
-
-	for (s=0;s<lp_numservices(lp_ctx);s++) {
-		struct loadparm_service *service = lp_servicebynum(lp_ctx, s);
-		if (service != NULL) {
-			const char **deny_list = lp_hostsdeny(service, lp_default_service(lp_ctx));
-			const char **allow_list = lp_hostsallow(service, lp_default_service(lp_ctx));
-			int i;
-			if(deny_list) {
-				for (i=0; deny_list[i]; i++) {
-					char *hasstar = strchr_m(deny_list[i], '*');
-					char *hasquery = strchr_m(deny_list[i], '?');
-					if(hasstar || hasquery) {
-						fprintf(stderr,"Invalid character %c in hosts deny list (%s) for service %s.\n",
-							   hasstar ? *hasstar : *hasquery, deny_list[i], lp_servicename(service) );
-					}
-				}
-			}
-
-			if(allow_list) {
-				for (i=0; allow_list[i]; i++) {
-					char *hasstar = strchr_m(allow_list[i], '*');
-					char *hasquery = strchr_m(allow_list[i], '?');
-					if(hasstar || hasquery) {
-						fprintf(stderr,"Invalid character %c in hosts allow list (%s) for service %s.\n",
-							   hasstar ? *hasstar : *hasquery, allow_list[i], lp_servicename(service) );
-					}
-				}
-			}
-		}
-	}
-
-
-	if (!cname) {
-		if (!silent_mode) {
-			fprintf(stderr,"Press enter to see a dump of your service definitions\n");
-			fflush(stdout);
-			getc(stdin);
-		}
-		if (section_name != NULL || parameter_name != NULL) {
-			struct loadparm_service *service = NULL;
-			if (!section_name) {
-				section_name = GLOBAL_NAME;
-				service = NULL;
-			} else if ((!strwicmp(section_name, GLOBAL_NAME)) == 0 &&
-				 (service=lp_service(lp_ctx, section_name)) == NULL) {
-					fprintf(stderr,"Unknown section %s\n",
-						section_name);
-					return(1);
-			}
-			if (!parameter_name) {
-				lp_dump_one(stdout, show_defaults, service, lp_default_service(lp_ctx));
-			} else {
-				ret = !lp_dump_a_parameter(lp_ctx, service, parameter_name, stdout);
-			}
-		} else {
-			lp_dump(lp_ctx, stdout, show_defaults, lp_numservices(lp_ctx));
-		}
-		return(ret);
-	}
-
-	if(cname && caddr){
-		/* this is totally ugly, a real `quick' hack */
-		for (s=0;s<lp_numservices(lp_ctx);s++) {
-			struct loadparm_service *service = lp_servicebynum(lp_ctx, s);
-			if (service != NULL) {
-				if (allow_access(NULL, lp_hostsdeny(NULL, lp_default_service(lp_ctx)), lp_hostsallow(NULL, lp_default_service(lp_ctx)), cname, caddr)
-				    && allow_access(NULL, lp_hostsdeny(service, lp_default_service(lp_ctx)), lp_hostsallow(service, lp_default_service(lp_ctx)), cname, caddr)) {
-					fprintf(stderr,"Allow connection from %s (%s) to %s\n",
-						   cname,caddr,lp_servicename(service));
-				} else {
-					fprintf(stderr,"Deny connection from %s (%s) to %s\n",
-						   cname,caddr,lp_servicename(service));
-				}
-			}
-		}
-	}
-
-	return ret;
-}
-
-
- int main(int argc, const char *argv[])
-{
-	int ret = 0;
-	poptContext pc;
-/*
-	static int show_all_parameters = 0;
-	static char *new_local_machine = NULL;
-*/
-	static const char *section_name = NULL;
-	static char *parameter_name = NULL;
-	static const char *cname;
-	static const char *caddr;
-	static int silent_mode = false;
-	static int show_defaults = false;  /* This must be an 'int',
-					    * as we take it as we pass
-					    * it's address as an int
-					    * pointer  */
-	struct loadparm_context *lp_ctx;
-
-	struct poptOption long_options[] = {
-		POPT_AUTOHELP
-		{"suppress-prompt", 0, POPT_ARG_NONE, &silent_mode, true, "Suppress prompt for enter"},
-		{"verbose", 'v', POPT_ARG_NONE, &show_defaults, true, "Show default options too"},
-/*
-  We need support for smb.conf macros before this will work again 
-		{"server", 'L',POPT_ARG_STRING, &new_local_machine, 0, "Set %%L macro to servername\n"},
-*/
-/*
-  These are harder to do with the new code structure
-		{"show-all-parameters", '\0', POPT_ARG_NONE, &show_all_parameters, 1, "Show the parameters, type, possible values" },
-*/
-		{"section-name", '\0', POPT_ARG_STRING, &section_name, 0, "Limit testparm to a named section" },
-		{"parameter-name", '\0', POPT_ARG_STRING, &parameter_name, 0, "Limit testparm to a named parameter" },
-		{"client-name", '\0', POPT_ARG_STRING, &cname, 0, "Client DNS name for 'hosts allow' checking (should match reverse lookup)"},
-		{"client-ip", '\0', POPT_ARG_STRING, &caddr, 0, "Client IP address for 'hosts allow' checking"},
-		POPT_COMMON_SAMBA
-		POPT_COMMON_VERSION
-		{ NULL }
-	};
-
-	setup_logging(NULL, DEBUG_STDERR);
-
-	pc = poptGetContext(NULL, argc, argv, long_options, 
-			    POPT_CONTEXT_KEEP_FIRST);
-	poptSetOtherOptionHelp(pc, "[OPTION...] [host-name] [host-ip]");
-
-	while(poptGetNextOpt(pc) != -1);
-
-/* 
-	if (show_all_parameters) {
-		show_parameter_list();
-		exit(0);
-	}
-*/
-
-	if ( cname && ! caddr ) {
-		printf ( "ERROR: For 'hosts allow' check you must specify both a DNS name and an IP address.\n" );
-		return(1);
-	}
-/*
-  We need support for smb.conf macros before this will work again 
-
-	if (new_local_machine) {
-		set_local_machine_name(new_local_machine, True);
-	}
-*/
-
-	lp_ctx = cmdline_lp_ctx;
-	
-	/* We need this to force the output */
-	lp_set_cmdline(lp_ctx, "log level", "2");
-
-	fprintf(stderr, "Loaded smb config files from %s\n", lp_configfile(lp_ctx));
-
-	if (!lp_load(lp_ctx, lp_configfile(lp_ctx))) {
-		fprintf(stderr,"Error loading services.\n");
-		return(1);
-	}
-
-	fprintf(stderr,"Loaded services file OK.\n");
-
-	ret = do_global_checks(lp_ctx);
-	ret |= do_share_checks(lp_ctx, cname, caddr, silent_mode, show_defaults, section_name, parameter_name);
-
-	return(ret);
-}
-
diff --git a/source4/utils/wscript_build b/source4/utils/wscript_build
index 5cbfe78fdb..a0b3ac5f9a 100644
--- a/source4/utils/wscript_build
+++ b/source4/utils/wscript_build
@@ -8,12 +8,6 @@ bld.SAMBA_BINARY('ntlm_auth',
 	)
 
 
-bld.SAMBA_BINARY('testparm',
-	source='testparm.c',
-	deps='LIBSAMBA-HOSTCONFIG LIBSAMBA-UTIL popt samba_socket POPT_SAMBA LIBCLI_RESOLVE CHARSET'
-	)
-
-
 bld.SAMBA_BINARY('oLschema2ldif',
 	source='oLschema2ldif.c',
 	manpages='man/oLschema2ldif.1',