VERSION: Bump version number up to 4.0.4.
[samba.git] / source4 / scripting / python / samba / getopt.py
index 1fbfd9c7136066015c65011793c9547585979182..c3c080084ec581504baafb24cc64ad620d97befb 100644 (file)
@@ -1,5 +1,3 @@
-#!/usr/bin/python
-
 # Samba-specific bits for optparse
 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
 #
 
 """Support for parsing Samba-related command-line options."""
 
+__docformat__ = "restructuredText"
+
 import optparse
-from credentials import Credentials, DONT_USE_KERBEROS, MUST_USE_KERBEROS
-from hostconfig import Hostconfig
-import samba
+import os
+from samba.credentials import (
+    Credentials,
+    AUTO_USE_KERBEROS,
+    DONT_USE_KERBEROS,
+    MUST_USE_KERBEROS,
+    )
+from samba.hostconfig import Hostconfig
+import sys
 
-__docformat__ = "restructuredText"
 
 class SambaOptions(optparse.OptionGroup):
     """General Samba-related command line options."""
+
     def __init__(self, parser):
+        from samba.param import LoadParm
         optparse.OptionGroup.__init__(self, parser, "Samba Common Options")
         self.add_option("-s", "--configfile", action="callback",
                         type=str, metavar="FILE", help="Configuration file",
@@ -36,32 +43,54 @@ class SambaOptions(optparse.OptionGroup):
         self.add_option("-d", "--debuglevel", action="callback",
                         type=int, metavar="DEBUGLEVEL", help="debug level",
                         callback=self._set_debuglevel)
+        self.add_option("--option", action="callback",
+                        type=str, metavar="OPTION",
+                        help="set smb.conf option from command line",
+                        callback=self._set_option)
+        self.add_option("--realm", action="callback",
+                        type=str, metavar="REALM", help="set the realm name",
+                        callback=self._set_realm)
         self._configfile = None
-        self._debuglevel = None
+        self._lp = LoadParm()
+        self.realm = None
 
     def get_loadparm_path(self):
-        """Return the path to the smb.conf file specified on the command line.  """
+        """Return path to the smb.conf file specified on the command line."""
         return self._configfile
 
     def _load_configfile(self, option, opt_str, arg, parser):
         self._configfile = arg
 
     def _set_debuglevel(self, option, opt_str, arg, parser):
-        self._debuglevel = arg
+        if arg < 0:
+            raise optparse.OptionValueError("invalid %s option value: %s" %
+                                            (opt_str, arg))
+        self._lp.set('debug level', str(arg))
+
+    def _set_realm(self, option, opt_str, arg, parser):
+        self._lp.set('realm', arg)
+        self.realm = arg
+
+    def _set_option(self, option, opt_str, arg, parser):
+        if arg.find('=') == -1:
+            raise optparse.OptionValueError(
+                "--option option takes a 'a=b' argument")
+        a = arg.split('=')
+        try:
+            self._lp.set(a[0], a[1])
+        except Exception, e:
+            raise optparse.OptionValueError(
+                "invalid --option option value %r: %s" % (arg, e))
 
     def get_loadparm(self):
-        """Return a loadparm object with data specified on the command line.  """
-        import os, param
-        lp = param.LoadParm()
+        """Return loadparm object with data specified on the command line."""
         if self._configfile is not None:
-            lp.load(self._configfile)
+            self._lp.load(self._configfile)
         elif os.getenv("SMB_CONF_PATH") is not None:
-            lp.load(os.getenv("SMB_CONF_PATH"))
+            self._lp.load(os.getenv("SMB_CONF_PATH"))
         else:
-            lp.load_default()
-        if self._debuglevel:
-            samba.set_debug_level(self._debuglevel)
-        return lp
+            self._lp.load_default()
+        return self._lp
 
     def get_hostconfig(self):
         return Hostconfig(self.get_loadparm())
@@ -71,12 +100,34 @@ class VersionOptions(optparse.OptionGroup):
     """Command line option for printing Samba version."""
     def __init__(self, parser):
         optparse.OptionGroup.__init__(self, parser, "Version Options")
+        self.add_option("-V", "--version", action="callback",
+                callback=self._display_version,
+                help="Display version number")
+
+    def _display_version(self, option, opt_str, arg, parser):
+        import samba
+        print samba.version
+        sys.exit(0)
+
+
+def parse_kerberos_arg(arg, opt_str):
+    if arg.lower() in ["yes", 'true', '1']:
+        return MUST_USE_KERBEROS
+    elif arg.lower() in ["no", 'false', '0']:
+        return DONT_USE_KERBEROS
+    elif arg.lower() in ["auto"]:
+        return AUTO_USE_KERBEROS
+    else:
+        raise optparse.OptionValueError("invalid %s option value: %s" %
+                                        (opt_str, arg))
 
 
 class CredentialsOptions(optparse.OptionGroup):
     """Command line options for specifying credentials."""
+
     def __init__(self, parser):
         self.no_pass = True
+        self.ipaddress = None
         optparse.OptionGroup.__init__(self, parser, "Credentials Options")
         self.add_option("--simple-bind-dn", metavar="DN", action="callback",
                         callback=self._set_simple_bind_dn, type=str,
@@ -94,6 +145,10 @@ class CredentialsOptions(optparse.OptionGroup):
         self.add_option("-k", "--kerberos", metavar="KERBEROS",
                         action="callback", type=str,
                         help="Use Kerberos", callback=self._set_kerberos)
+        self.add_option("", "--ipaddress", metavar="IPADDRESS",
+                        action="callback", type=str,
+                        help="IP address of server",
+                        callback=self._set_ipaddress)
         self.creds = Credentials()
 
     def _parse_username(self, option, opt_str, arg, parser):
@@ -106,16 +161,16 @@ class CredentialsOptions(optparse.OptionGroup):
         self.creds.set_password(arg)
         self.no_pass = False
 
+    def _set_ipaddress(self, option, opt_str, arg, parser):
+        self.ipaddress = arg
+
     def _set_kerberos(self, option, opt_str, arg, parser):
-        if bool(arg) or arg.lower() == "yes":
-            self.creds.set_kerberos_state(MUST_USE_KERBEROS)
-        else:
-            self.creds.set_kerberos_state(DONT_USE_KERBEROS)
+        self.creds.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 
     def _set_simple_bind_dn(self, option, opt_str, arg, parser):
         self.creds.set_bind_dn(arg)
 
-    def get_credentials(self, lp):
+    def get_credentials(self, lp, fallback_machine=False):
         """Obtain the credentials set on the command-line.
 
         :param lp: Loadparm object to use.
@@ -124,10 +179,21 @@ class CredentialsOptions(optparse.OptionGroup):
         self.creds.guess(lp)
         if self.no_pass:
             self.creds.set_cmdline_callbacks()
+
+        # possibly fallback to using the machine account, if we have
+        # access to the secrets db
+        if fallback_machine and not self.creds.authentication_requested():
+            try:
+                self.creds.set_machine_account(lp)
+            except Exception:
+                pass
+
         return self.creds
 
+
 class CredentialsOptionsDouble(CredentialsOptions):
     """Command line options for specifying credentials of two servers."""
+
     def __init__(self, parser):
         CredentialsOptions.__init__(self, parser)
         self.no_pass2 = True
@@ -135,13 +201,16 @@ class CredentialsOptionsDouble(CredentialsOptions):
                         callback=self._set_simple_bind_dn2, type=str,
                         help="DN to use for a simple bind")
         self.add_option("--password2", metavar="PASSWORD2", action="callback",
-                        help="Password", type=str, callback=self._set_password2)
+                        help="Password", type=str,
+                        callback=self._set_password2)
         self.add_option("--username2", metavar="USERNAME2",
                         action="callback", type=str,
-                        help="Username for second server", callback=self._parse_username2)
+                        help="Username for second server",
+                        callback=self._parse_username2)
         self.add_option("--workgroup2", metavar="WORKGROUP2",
                         action="callback", type=str,
-                        help="Workgroup for second server", callback=self._parse_workgroup2)
+                        help="Workgroup for second server",
+                        callback=self._parse_workgroup2)
         self.add_option("--no-pass2", action="store_true",
                         help="Don't ask for a password for the second server")
         self.add_option("--kerberos2", metavar="KERBEROS2",
@@ -160,21 +229,23 @@ class CredentialsOptionsDouble(CredentialsOptions):
         self.no_pass2 = False
 
     def _set_kerberos2(self, option, opt_str, arg, parser):
-        if bool(arg) or arg.lower() == "yes":
-            self.creds2.set_kerberos_state(MUST_USE_KERBEROS)
-        else:
-            self.creds2.set_kerberos_state(DONT_USE_KERBEROS)
+        self.creds2.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 
     def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
         self.creds2.set_bind_dn(arg)
 
-    def get_credentials2(self, lp):
+    def get_credentials2(self, lp, guess=True):
         """Obtain the credentials set on the command-line.
 
         :param lp: Loadparm object to use.
+        :param guess: Try guess Credentials from environment
         :return: Credentials object
         """
-        self.creds2.guess(lp)
+        if guess:
+            self.creds2.guess(lp)
+        elif not self.creds2.get_username():
+            self.creds2.set_anonymous()
+
         if self.no_pass2:
             self.creds2.set_cmdline_callbacks()
         return self.creds2