3 # Unix SMB/CIFS implementation.
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2009
5 # Copyright (C) Theresa Halloran <theresahalloran@gmail.com> 2011
6 # Copyright (C) Giampaolo Lauria <lauria2@yahoo.com> 2011
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
22 import optparse
, samba
23 from samba
import getopt
as options
24 from ldb
import LdbError
28 class Option(optparse
.Option
):
33 class Command(object):
34 """A %prog command."""
36 def _get_description(self
):
37 return self
.__doc
__.splitlines()[0].rstrip("\n")
40 name
= self
.__class
__.__name
__
41 if name
.startswith("cmd_"):
45 name
= property(_get_name
)
47 def usage(self
, *args
):
48 parser
, _
= self
._create
_parser
()
51 description
= property(_get_description
)
53 def show_command_error(self
, e
):
54 '''display a command error'''
55 if isinstance(e
, CommandError
):
56 (etype
, evalue
, etraceback
) = e
.exception_info
57 inner_exception
= e
.inner_exception
59 force_traceback
= False
61 (etype
, evalue
, etraceback
) = sys
.exc_info()
63 message
= "uncaught exception"
64 force_traceback
= True
66 if isinstance(inner_exception
, LdbError
):
67 (ldb_ecode
, ldb_emsg
) = inner_exception
68 print >>sys
.stderr
, "ERROR(ldb): %s - %s" % (message
, ldb_emsg
)
69 elif isinstance(inner_exception
, AssertionError):
70 print >>sys
.stderr
, "ERROR(assert): %s" % message
71 force_traceback
= True
72 elif isinstance(inner_exception
, RuntimeError):
73 print >>sys
.stderr
, "ERROR(runtime): %s - %s" % (message
, evalue
)
74 elif type(inner_exception
) is Exception:
75 print >>sys
.stderr
, "ERROR(exception): %s - %s" % (message
, evalue
)
76 force_traceback
= True
77 elif inner_exception
is None:
78 print >>sys
.stderr
, "ERROR: %s" % (message
)
80 print >>sys
.stderr
, "ERROR(%s): %s - %s" % (str(etype
), message
, evalue
)
81 force_traceback
= True
83 if force_traceback
or samba
.get_debug_level() >= 3:
84 traceback
.print_tb(etraceback
)
88 # synopsis must be defined in all subclasses in order to provide the command usage
92 takes_optiongroups
= {
93 "sambaopts": options
.SambaOptions
,
94 "credopts": options
.CredentialsOptions
,
95 "versionopts": options
.VersionOptions
,
98 def _create_parser(self
):
99 parser
= optparse
.OptionParser(self
.synopsis
)
100 parser
.add_options(self
.takes_options
)
102 for name
, optiongroup
in self
.takes_optiongroups
.iteritems():
103 optiongroups
[name
] = optiongroup(parser
)
104 parser
.add_option_group(optiongroups
[name
])
105 return parser
, optiongroups
107 def message(self
, text
):
110 def _run(self
, *argv
):
111 parser
, optiongroups
= self
._create
_parser
()
112 opts
, args
= parser
.parse_args(list(argv
))
113 # Filter out options from option groups
115 kwargs
= dict(opts
.__dict
__)
116 for option_group
in parser
.option_groups
:
117 for option
in option_group
.option_list
:
118 if option
.dest
is not None:
119 del kwargs
[option
.dest
]
120 kwargs
.update(optiongroups
)
122 # Check for a min a max number of allowed arguments, whenever possible
123 # The suffix "?" means zero or one occurence
124 # The suffix "+" means at least one occurence
127 undetermined_max_args
= False
128 for i
, arg
in enumerate(self
.takes_args
):
132 undetermined_max_args
= True
135 if (len(args
) < min_args
) or (undetermined_max_args
== False and len(args
) > max_args
):
140 return self
.run(*args
, **kwargs
)
142 self
.show_command_error(e
)
146 """Run the command. This should be overriden by all subclasses."""
147 raise NotImplementedError(self
.run
)
151 class SuperCommand(Command
):
152 """A %prog command with subcommands."""
156 def _run(self
, myname
, subcommand
=None, *args
):
157 if subcommand
in self
.subcommands
:
158 return self
.subcommands
[subcommand
]._run
(subcommand
, *args
)
159 print "Available subcommands:"
160 for cmd
in self
.subcommands
:
161 print "\t%-20s - %s" % (cmd
, self
.subcommands
[cmd
].description
)
162 if subcommand
in [None]:
163 self
.show_command_error("You must specify a subcommand")
165 if subcommand
in ['-h', '--help']:
166 print "For more help on a specific subcommand, please type: samba-tool %s <subcommand> (-h|--help)" % myname
168 self
.show_command_error("No such subcommand '%s'" % (subcommand
))
170 def show_command_error(self
, msg
):
171 '''display a command error'''
173 print >>sys
.stderr
, "ERROR: %s" % (msg
)
176 def usage(self
, myname
, subcommand
=None, *args
):
177 if subcommand
is None or not subcommand
in self
.subcommands
:
178 print "Usage: %s (%s) [options]" % (myname
,
179 " | ".join(self
.subcommands
.keys()))
181 return self
.subcommands
[subcommand
].usage(*args
)
185 class CommandError(Exception):
186 '''an exception class for %prog cmd errors'''
187 def __init__(self
, message
, inner_exception
=None):
188 self
.message
= message
189 self
.inner_exception
= inner_exception
190 self
.exception_info
= sys
.exc_info()
195 from samba
.netcmd
.newuser
import cmd_newuser
196 commands
["newuser"] = cmd_newuser()
197 from samba
.netcmd
.netacl
import cmd_acl
198 commands
["acl"] = cmd_acl()
199 from samba
.netcmd
.fsmo
import cmd_fsmo
200 commands
["fsmo"] = cmd_fsmo()
201 from samba
.netcmd
.time
import cmd_time
202 commands
["time"] = cmd_time()
203 from samba
.netcmd
.user
import cmd_user
204 commands
["user"] = cmd_user()
205 from samba
.netcmd
.vampire
import cmd_vampire
206 commands
["vampire"] = cmd_vampire()
207 from samba
.netcmd
.spn
import cmd_spn
208 commands
["spn"] = cmd_spn()
209 from samba
.netcmd
.group
import cmd_group
210 commands
["group"] = cmd_group()
211 from samba
.netcmd
.rodc
import cmd_rodc
212 commands
["rodc"] = cmd_rodc()
213 from samba
.netcmd
.drs
import cmd_drs
214 commands
["drs"] = cmd_drs()
215 from samba
.netcmd
.gpo
import cmd_gpo
216 commands
["gpo2"] = cmd_gpo()
217 from samba
.netcmd
.ldapcmp
import cmd_ldapcmp
218 commands
["ldapcmp"] = cmd_ldapcmp()
219 from samba
.netcmd
.testparm
import cmd_testparm
220 commands
["testparm"] = cmd_testparm()
221 from samba
.netcmd
.dbcheck
import cmd_dbcheck
222 commands
["dbcheck"] = cmd_dbcheck()
223 from samba
.netcmd
.delegation
import cmd_delegation
224 commands
["delegation"] = cmd_delegation()
225 from samba
.netcmd
.domain
import cmd_domain
226 commands
["domain"] = cmd_domain()