lib/util: charset modules do not exist any more
[ab/samba.git/.git] / source4 / scripting / python / samba / getopt.py
1 # Samba-specific bits for optparse
2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
3 #
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 3 of the License, or
7 # (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 #
17
18 """Support for parsing Samba-related command-line options."""
19
20 __docformat__ = "restructuredText"
21
22 import optparse
23 import os
24 from samba.credentials import (
25     Credentials,
26     AUTO_USE_KERBEROS,
27     DONT_USE_KERBEROS,
28     MUST_USE_KERBEROS,
29     )
30 from samba.hostconfig import Hostconfig
31 import sys
32
33
34 class SambaOptions(optparse.OptionGroup):
35     """General Samba-related command line options."""
36
37     def __init__(self, parser):
38         from samba.param import LoadParm
39         optparse.OptionGroup.__init__(self, parser, "Samba Common Options")
40         self.add_option("-s", "--configfile", action="callback",
41                         type=str, metavar="FILE", help="Configuration file",
42                         callback=self._load_configfile)
43         self.add_option("-d", "--debuglevel", action="callback",
44                         type=int, metavar="DEBUGLEVEL", help="debug level",
45                         callback=self._set_debuglevel)
46         self.add_option("--option", action="callback",
47                         type=str, metavar="OPTION",
48                         help="set smb.conf option from command line",
49                         callback=self._set_option)
50         self.add_option("--realm", action="callback",
51                         type=str, metavar="REALM", help="set the realm name",
52                         callback=self._set_realm)
53         self._configfile = None
54         self._lp = LoadParm()
55         self.realm = None
56
57     def get_loadparm_path(self):
58         """Return path to the smb.conf file specified on the command line."""
59         return self._configfile
60
61     def _load_configfile(self, option, opt_str, arg, parser):
62         self._configfile = arg
63
64     def _set_debuglevel(self, option, opt_str, arg, parser):
65         if arg < 0:
66             raise optparse.OptionValueError("invalid %s option value: %s" %
67                                             (opt_str, arg))
68         self._lp.set('debug level', str(arg))
69
70     def _set_realm(self, option, opt_str, arg, parser):
71         self._lp.set('realm', arg)
72         self.realm = arg
73
74     def _set_option(self, option, opt_str, arg, parser):
75         if arg.find('=') == -1:
76             raise optparse.OptionValueError(
77                 "--option option takes a 'a=b' argument")
78         a = arg.split('=')
79         try:
80             self._lp.set(a[0], a[1])
81         except Exception, e:
82             raise optparse.OptionValueError(
83                 "invalid --option option value %r: %s" % (arg, e))
84
85     def get_loadparm(self):
86         """Return loadparm object with data specified on the command line."""
87         if self._configfile is not None:
88             self._lp.load(self._configfile)
89         elif os.getenv("SMB_CONF_PATH") is not None:
90             self._lp.load(os.getenv("SMB_CONF_PATH"))
91         else:
92             self._lp.load_default()
93         return self._lp
94
95     def get_hostconfig(self):
96         return Hostconfig(self.get_loadparm())
97
98
99 class VersionOptions(optparse.OptionGroup):
100     """Command line option for printing Samba version."""
101     def __init__(self, parser):
102         optparse.OptionGroup.__init__(self, parser, "Version Options")
103         self.add_option("--version", action="callback",
104                 callback=self._display_version,
105                 help="Display version number")
106
107     def _display_version(self, option, opt_str, arg, parser):
108         import samba
109         print samba.version
110         sys.exit(0)
111
112
113 def parse_kerberos_arg(arg, opt_str):
114     if arg.lower() in ["yes", 'true', '1']:
115         return MUST_USE_KERBEROS
116     elif arg.lower() in ["no", 'false', '0']:
117         return DONT_USE_KERBEROS
118     elif arg.lower() in ["auto"]:
119         return AUTO_USE_KERBEROS
120     else:
121         raise optparse.OptionValueError("invalid %s option value: %s" %
122                                         (opt_str, arg))
123
124
125 class CredentialsOptions(optparse.OptionGroup):
126     """Command line options for specifying credentials."""
127
128     def __init__(self, parser):
129         self.no_pass = True
130         self.ipaddress = None
131         optparse.OptionGroup.__init__(self, parser, "Credentials Options")
132         self.add_option("--simple-bind-dn", metavar="DN", action="callback",
133                         callback=self._set_simple_bind_dn, type=str,
134                         help="DN to use for a simple bind")
135         self.add_option("--password", metavar="PASSWORD", action="callback",
136                         help="Password", type=str, callback=self._set_password)
137         self.add_option("-U", "--username", metavar="USERNAME",
138                         action="callback", type=str,
139                         help="Username", callback=self._parse_username)
140         self.add_option("-W", "--workgroup", metavar="WORKGROUP",
141                         action="callback", type=str,
142                         help="Workgroup", callback=self._parse_workgroup)
143         self.add_option("-N", "--no-pass", action="store_true",
144                         help="Don't ask for a password")
145         self.add_option("-k", "--kerberos", metavar="KERBEROS",
146                         action="callback", type=str,
147                         help="Use Kerberos", callback=self._set_kerberos)
148         self.add_option("", "--ipaddress", metavar="IPADDRESS",
149                         action="callback", type=str,
150                         help="IP address of server",
151                         callback=self._set_ipaddress)
152         self.creds = Credentials()
153
154     def _parse_username(self, option, opt_str, arg, parser):
155         self.creds.parse_string(arg)
156
157     def _parse_workgroup(self, option, opt_str, arg, parser):
158         self.creds.set_domain(arg)
159
160     def _set_password(self, option, opt_str, arg, parser):
161         self.creds.set_password(arg)
162         self.no_pass = False
163
164     def _set_ipaddress(self, option, opt_str, arg, parser):
165         self.ipaddress = arg
166
167     def _set_kerberos(self, option, opt_str, arg, parser):
168         self.creds.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
169
170     def _set_simple_bind_dn(self, option, opt_str, arg, parser):
171         self.creds.set_bind_dn(arg)
172
173     def get_credentials(self, lp, fallback_machine=False):
174         """Obtain the credentials set on the command-line.
175
176         :param lp: Loadparm object to use.
177         :return: Credentials object
178         """
179         self.creds.guess(lp)
180         if self.no_pass:
181             self.creds.set_cmdline_callbacks()
182
183         # possibly fallback to using the machine account, if we have
184         # access to the secrets db
185         if fallback_machine and not self.creds.authentication_requested():
186             try:
187                 self.creds.set_machine_account(lp)
188             except Exception:
189                 pass
190
191         return self.creds
192
193
194 class CredentialsOptionsDouble(CredentialsOptions):
195     """Command line options for specifying credentials of two servers."""
196
197     def __init__(self, parser):
198         CredentialsOptions.__init__(self, parser)
199         self.no_pass2 = True
200         self.add_option("--simple-bind-dn2", metavar="DN2", action="callback",
201                         callback=self._set_simple_bind_dn2, type=str,
202                         help="DN to use for a simple bind")
203         self.add_option("--password2", metavar="PASSWORD2", action="callback",
204                         help="Password", type=str,
205                         callback=self._set_password2)
206         self.add_option("--username2", metavar="USERNAME2",
207                         action="callback", type=str,
208                         help="Username for second server",
209                         callback=self._parse_username2)
210         self.add_option("--workgroup2", metavar="WORKGROUP2",
211                         action="callback", type=str,
212                         help="Workgroup for second server",
213                         callback=self._parse_workgroup2)
214         self.add_option("--no-pass2", action="store_true",
215                         help="Don't ask for a password for the second server")
216         self.add_option("--kerberos2", metavar="KERBEROS2",
217                         action="callback", type=str,
218                         help="Use Kerberos", callback=self._set_kerberos2)
219         self.creds2 = Credentials()
220
221     def _parse_username2(self, option, opt_str, arg, parser):
222         self.creds2.parse_string(arg)
223
224     def _parse_workgroup2(self, option, opt_str, arg, parser):
225         self.creds2.set_domain(arg)
226
227     def _set_password2(self, option, opt_str, arg, parser):
228         self.creds2.set_password(arg)
229         self.no_pass2 = False
230
231     def _set_kerberos2(self, option, opt_str, arg, parser):
232         self.creds2.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
233
234     def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
235         self.creds2.set_bind_dn(arg)
236
237     def get_credentials2(self, lp, guess=True):
238         """Obtain the credentials set on the command-line.
239
240         :param lp: Loadparm object to use.
241         :param guess: Try guess Credentials from environment
242         :return: Credentials object
243         """
244         if guess:
245             self.creds2.guess(lp)
246         elif not self.creds2.get_username():
247             self.creds2.set_anonymous()
248
249         if self.no_pass2:
250             self.creds2.set_cmdline_callbacks()
251         return self.creds2