← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-06-06 11:49:47 UTC
  • Revision ID: mbp@sourcefrog.net-20050606114947-0ad5aa9f61ce6f59
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
# TODO: probably should say which arguments are candidates for glob
19
 
# expansion on windows and do that at the command level.
20
 
 
21
 
# TODO: Help messages for options.
22
 
 
23
 
# TODO: Define arguments by objects, rather than just using names.
24
 
# Those objects can specify the expected type of the argument, which
25
 
# would help with validation and shell completion.
26
 
 
27
 
 
28
 
 
29
 
import sys
30
 
import os
31
 
from warnings import warn
32
 
from inspect import getdoc
 
18
 
 
19
import sys, os
33
20
 
34
21
import bzrlib
35
 
import bzrlib.trace
36
 
from bzrlib.trace import mutter, note, log_error, warning
37
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
 
from bzrlib.branch import find_branch
39
 
from bzrlib import BZRDIR
40
 
 
41
 
plugin_cmds = {}
42
 
 
43
 
 
44
 
def register_command(cmd):
45
 
    "Utility function to help register a command"
46
 
    global plugin_cmds
47
 
    k = cmd.__name__
48
 
    if k.startswith("cmd_"):
49
 
        k_unsquished = _unsquish_command_name(k)
50
 
    else:
51
 
        k_unsquished = k
52
 
    if not plugin_cmds.has_key(k_unsquished):
53
 
        plugin_cmds[k_unsquished] = cmd
54
 
        mutter('registered plugin command %s', k_unsquished)      
55
 
    else:
56
 
        log_error('Two plugins defined the same command: %r' % k)
57
 
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
22
from bzrlib.trace import mutter, note, log_error
 
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
 
24
from bzrlib.osutils import quotefn
 
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
26
     format_date
58
27
 
59
28
 
60
29
def _squish_command_name(cmd):
65
34
    assert cmd.startswith("cmd_")
66
35
    return cmd[4:].replace('_','-')
67
36
 
68
 
 
69
37
def _parse_revision_str(revstr):
70
 
    """This handles a revision string -> revno.
71
 
 
72
 
    This always returns a list.  The list will have one element for 
73
 
 
74
 
    It supports integers directly, but everything else it
75
 
    defers for passing to Branch.get_revision_info()
76
 
 
77
 
    >>> _parse_revision_str('234')
78
 
    [234]
79
 
    >>> _parse_revision_str('234..567')
80
 
    [234, 567]
81
 
    >>> _parse_revision_str('..')
82
 
    [None, None]
83
 
    >>> _parse_revision_str('..234')
84
 
    [None, 234]
85
 
    >>> _parse_revision_str('234..')
86
 
    [234, None]
87
 
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
 
    [234, 456, 789]
89
 
    >>> _parse_revision_str('234....789') # Error?
90
 
    [234, None, 789]
91
 
    >>> _parse_revision_str('revid:test@other.com-234234')
92
 
    ['revid:test@other.com-234234']
93
 
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
 
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
 
    >>> _parse_revision_str('revid:test@other.com-234234..23')
96
 
    ['revid:test@other.com-234234', 23]
97
 
    >>> _parse_revision_str('date:2005-04-12')
98
 
    ['date:2005-04-12']
99
 
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
100
 
    ['date:2005-04-12 12:24:33']
101
 
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
102
 
    ['date:2005-04-12T12:24:33']
103
 
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
104
 
    ['date:2005-04-12,12:24:33']
105
 
    >>> _parse_revision_str('-5..23')
106
 
    [-5, 23]
107
 
    >>> _parse_revision_str('-5')
108
 
    [-5]
109
 
    >>> _parse_revision_str('123a')
110
 
    ['123a']
111
 
    >>> _parse_revision_str('abc')
112
 
    ['abc']
 
38
    """This handles a revision string -> revno. 
 
39
 
 
40
    There are several possibilities:
 
41
 
 
42
        '234'       -> 234
 
43
        '234:345'   -> [234, 345]
 
44
        ':234'      -> [None, 234]
 
45
        '234:'      -> [234, None]
 
46
 
 
47
    In the future we will also support:
 
48
        'uuid:blah-blah-blah'   -> ?
 
49
        'hash:blahblahblah'     -> ?
 
50
        potentially:
 
51
        'tag:mytag'             -> ?
113
52
    """
114
 
    import re
115
 
    old_format_re = re.compile('\d*:\d*')
116
 
    m = old_format_re.match(revstr)
117
 
    if m:
118
 
        warning('Colon separator for revision numbers is deprecated.'
119
 
                ' Use .. instead')
120
 
        revs = []
121
 
        for rev in revstr.split(':'):
122
 
            if rev:
123
 
                revs.append(int(rev))
124
 
            else:
125
 
                revs.append(None)
126
 
        return revs
127
 
    revs = []
128
 
    for x in revstr.split('..'):
129
 
        if not x:
130
 
            revs.append(None)
131
 
        else:
132
 
            try:
133
 
                revs.append(int(x))
134
 
            except ValueError:
135
 
                revs.append(x)
 
53
    if revstr.find(':') != -1:
 
54
        revs = revstr.split(':')
 
55
        if len(revs) > 2:
 
56
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
57
 
 
58
        if not revs[0]:
 
59
            revs[0] = None
 
60
        else:
 
61
            revs[0] = int(revs[0])
 
62
 
 
63
        if not revs[1]:
 
64
            revs[1] = None
 
65
        else:
 
66
            revs[1] = int(revs[1])
 
67
    else:
 
68
        revs = int(revstr)
136
69
    return revs
137
70
 
138
 
 
139
 
def get_merge_type(typestring):
140
 
    """Attempt to find the merge class/factory associated with a string."""
141
 
    from merge import merge_types
142
 
    try:
143
 
        return merge_types[typestring][0]
144
 
    except KeyError:
145
 
        templ = '%s%%7s: %%s' % (' '*12)
146
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
 
        type_list = '\n'.join(lines)
148
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
149
 
            (typestring, type_list)
150
 
        raise BzrCommandError(msg)
151
 
    
152
 
 
153
 
def _builtin_commands():
154
 
    import bzrlib.builtins
155
 
    r = {}
156
 
    builtins = bzrlib.builtins.__dict__
157
 
    for name in builtins:
158
 
        if name.startswith("cmd_"):
159
 
            real_name = _unsquish_command_name(name)        
160
 
            r[real_name] = builtins[name]
161
 
    return r
162
 
 
163
 
            
164
 
 
165
 
def builtin_command_names():
166
 
    """Return list of builtin command names."""
167
 
    return _builtin_commands().keys()
168
 
    
169
 
 
170
 
def plugin_command_names():
171
 
    return plugin_cmds.keys()
172
 
 
173
 
 
174
 
def _get_cmd_dict(plugins_override=True):
175
 
    """Return name->class mapping for all commands."""
176
 
    d = _builtin_commands()
177
 
    if plugins_override:
178
 
        d.update(plugin_cmds)
179
 
    return d
180
 
 
181
 
    
182
 
def get_all_cmds(plugins_override=True):
 
71
def get_all_cmds():
183
72
    """Return canonical name and class for all registered commands."""
184
 
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
185
 
        yield k,v
186
 
 
187
 
 
188
 
def get_cmd_object(cmd_name, plugins_override=True):
 
73
    for k, v in globals().iteritems():
 
74
        if k.startswith("cmd_"):
 
75
            yield _unsquish_command_name(k), v
 
76
 
 
77
def get_cmd_class(cmd):
189
78
    """Return the canonical name and command class for a command.
190
 
 
191
 
    plugins_override
192
 
        If true, plugin commands can override builtins.
193
79
    """
194
 
    from bzrlib.externalcommand import ExternalCommand
195
 
 
196
 
    cmd_name = str(cmd_name)            # not unicode
 
80
    cmd = str(cmd)                      # not unicode
197
81
 
198
82
    # first look up this command under the specified name
199
 
    cmds = _get_cmd_dict(plugins_override=plugins_override)
200
83
    try:
201
 
        return cmds[cmd_name]()
 
84
        return cmd, globals()[_squish_command_name(cmd)]
202
85
    except KeyError:
203
86
        pass
204
87
 
205
88
    # look for any command which claims this as an alias
206
 
    for real_cmd_name, cmd_class in cmds.iteritems():
207
 
        if cmd_name in cmd_class.aliases:
208
 
            return cmd_class()
209
 
 
210
 
    cmd_obj = ExternalCommand.find_command(cmd_name)
211
 
    if cmd_obj:
212
 
        return cmd_obj
213
 
 
214
 
    raise BzrCommandError("unknown command %r" % cmd_name)
 
89
    for cmdname, cmdclass in get_all_cmds():
 
90
        if cmd in cmdclass.aliases:
 
91
            return cmdname, cmdclass
 
92
 
 
93
    cmdclass = ExternalCommand.find_command(cmd)
 
94
    if cmdclass:
 
95
        return cmd, cmdclass
 
96
 
 
97
    raise BzrCommandError("unknown command %r" % cmd)
215
98
 
216
99
 
217
100
class Command(object):
218
101
    """Base class for commands.
219
102
 
220
 
    Commands are the heart of the command-line bzr interface.
221
 
 
222
 
    The command object mostly handles the mapping of command-line
223
 
    parameters into one or more bzrlib operations, and of the results
224
 
    into textual output.
225
 
 
226
 
    Commands normally don't have any state.  All their arguments are
227
 
    passed in to the run method.  (Subclasses may take a different
228
 
    policy if the behaviour of the instance needs to depend on e.g. a
229
 
    shell plugin and not just its Python class.)
230
 
 
231
103
    The docstring for an actual command should give a single-line
232
104
    summary, then a complete description of the command.  A grammar
233
105
    description will be inserted.
234
106
 
235
 
    aliases
236
 
        Other accepted names for this command.
237
 
 
238
107
    takes_args
239
108
        List of argument forms, marked with whether they are optional,
240
109
        repeated, etc.
243
112
        List of options that may be given for this command.
244
113
 
245
114
    hidden
246
 
        If true, this command isn't advertised.  This is typically
247
 
        for commands intended for expert users.
 
115
        If true, this command isn't advertised.
248
116
    """
249
117
    aliases = []
250
118
    
253
121
 
254
122
    hidden = False
255
123
    
256
 
    def __init__(self):
257
 
        """Construct an instance of this command."""
258
 
        if self.__doc__ == Command.__doc__:
259
 
            warn("No help message set for %r" % self)
260
 
 
261
 
 
262
 
    def run_argv(self, argv):
263
 
        """Parse command line and run."""
264
 
        args, opts = parse_args(argv)
265
 
 
266
 
        if 'help' in opts:  # e.g. bzr add --help
267
 
            from bzrlib.help import help_on_command
268
 
            help_on_command(self.name())
269
 
            return 0
270
 
 
271
 
        # check options are reasonable
272
 
        allowed = self.takes_options
273
 
        for oname in opts:
274
 
            if oname not in allowed:
275
 
                raise BzrCommandError("option '--%s' is not allowed for command %r"
276
 
                                      % (oname, self.name()))
277
 
 
278
 
        # mix arguments and options into one dictionary
279
 
        cmdargs = _match_argform(self.name(), self.takes_args, args)
280
 
        cmdopts = {}
281
 
        for k, v in opts.items():
282
 
            cmdopts[k.replace('-', '_')] = v
283
 
 
284
 
        all_cmd_args = cmdargs.copy()
285
 
        all_cmd_args.update(cmdopts)
286
 
 
287
 
        return self.run(**all_cmd_args)
 
124
    def __init__(self, options, arguments):
 
125
        """Construct and run the command.
 
126
 
 
127
        Sets self.status to the return value of run()."""
 
128
        assert isinstance(options, dict)
 
129
        assert isinstance(arguments, dict)
 
130
        cmdargs = options.copy()
 
131
        cmdargs.update(arguments)
 
132
        assert self.__doc__ != Command.__doc__, \
 
133
               ("No help message set for %r" % self)
 
134
        self.status = self.run(**cmdargs)
288
135
 
289
136
    
290
137
    def run(self):
291
 
        """Actually run the command.
 
138
        """Override this in sub-classes.
292
139
 
293
140
        This is invoked with the options and arguments bound to
294
141
        keyword parameters.
295
142
 
296
 
        Return 0 or None if the command was successful, or a non-zero
297
 
        shell error code if not.  It's OK for this method to allow
298
 
        an exception to raise up.
 
143
        Return 0 or None if the command was successful, or a shell
 
144
        error code if not.
299
145
        """
300
 
        raise NotImplementedError()
301
 
 
302
 
 
303
 
    def help(self):
304
 
        """Return help message for this class."""
305
 
        if self.__doc__ is Command.__doc__:
306
 
            return None
307
 
        return getdoc(self)
308
 
 
309
 
    def name(self):
310
 
        return _unsquish_command_name(self.__class__.__name__)
311
 
 
 
146
        return 0
 
147
 
 
148
 
 
149
class ExternalCommand(Command):
 
150
    """Class to wrap external commands.
 
151
 
 
152
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
153
    an object we construct that has the appropriate path, help, options etc for the
 
154
    specified command.
 
155
 
 
156
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
157
    method, which we override to call the Command.__init__ method. That then calls
 
158
    our run method which is pretty straight forward.
 
159
 
 
160
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
161
    back into command line options and arguments for the script.
 
162
    """
 
163
 
 
164
    def find_command(cls, cmd):
 
165
        import os.path
 
166
        bzrpath = os.environ.get('BZRPATH', '')
 
167
 
 
168
        for dir in bzrpath.split(':'):
 
169
            path = os.path.join(dir, cmd)
 
170
            if os.path.isfile(path):
 
171
                return ExternalCommand(path)
 
172
 
 
173
        return None
 
174
 
 
175
    find_command = classmethod(find_command)
 
176
 
 
177
    def __init__(self, path):
 
178
        self.path = path
 
179
 
 
180
        # TODO: If either of these fail, we should detect that and
 
181
        # assume that path is not really a bzr plugin after all.
 
182
 
 
183
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
184
        self.takes_options = pipe.readline().split()
 
185
        self.takes_args = pipe.readline().split()
 
186
        pipe.close()
 
187
 
 
188
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
189
        self.__doc__ = pipe.read()
 
190
        pipe.close()
 
191
 
 
192
    def __call__(self, options, arguments):
 
193
        Command.__init__(self, options, arguments)
 
194
        return self
 
195
 
 
196
    def run(self, **kargs):
 
197
        opts = []
 
198
        args = []
 
199
 
 
200
        keys = kargs.keys()
 
201
        keys.sort()
 
202
        for name in keys:
 
203
            value = kargs[name]
 
204
            if OPTIONS.has_key(name):
 
205
                # it's an option
 
206
                opts.append('--%s' % name)
 
207
                if value is not None and value is not True:
 
208
                    opts.append(str(value))
 
209
            else:
 
210
                # it's an arg, or arg list
 
211
                if type(value) is not list:
 
212
                    value = [value]
 
213
                for v in value:
 
214
                    if v is not None:
 
215
                        args.append(str(v))
 
216
 
 
217
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
218
        return self.status
 
219
 
 
220
 
 
221
class cmd_status(Command):
 
222
    """Display status summary.
 
223
 
 
224
    This reports on versioned and unknown files, reporting them
 
225
    grouped by state.  Possible states are:
 
226
 
 
227
    added
 
228
        Versioned in the working copy but not in the previous revision.
 
229
 
 
230
    removed
 
231
        Versioned in the previous revision but removed or deleted
 
232
        in the working copy.
 
233
 
 
234
    renamed
 
235
        Path of this file changed from the previous revision;
 
236
        the text may also have changed.  This includes files whose
 
237
        parent directory was renamed.
 
238
 
 
239
    modified
 
240
        Text has changed since the previous revision.
 
241
 
 
242
    unchanged
 
243
        Nothing about this file has changed since the previous revision.
 
244
        Only shown with --all.
 
245
 
 
246
    unknown
 
247
        Not versioned and not matching an ignore pattern.
 
248
 
 
249
    To see ignored files use 'bzr ignored'.  For details in the
 
250
    changes to file texts, use 'bzr diff'.
 
251
 
 
252
    If no arguments are specified, the status of the entire working
 
253
    directory is shown.  Otherwise, only the status of the specified
 
254
    files or directories is reported.  If a directory is given, status
 
255
    is reported for everything inside that directory.
 
256
    """
 
257
    takes_args = ['file*']
 
258
    takes_options = ['all', 'show-ids']
 
259
    aliases = ['st', 'stat']
 
260
    
 
261
    def run(self, all=False, show_ids=False, file_list=None):
 
262
        if file_list:
 
263
            b = Branch(file_list[0])
 
264
            file_list = [b.relpath(x) for x in file_list]
 
265
            # special case: only one path was given and it's the root
 
266
            # of the branch
 
267
            if file_list == ['']:
 
268
                file_list = None
 
269
        else:
 
270
            b = Branch('.')
 
271
        import status
 
272
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
273
                           specific_files=file_list)
 
274
 
 
275
 
 
276
class cmd_cat_revision(Command):
 
277
    """Write out metadata for a revision."""
 
278
 
 
279
    hidden = True
 
280
    takes_args = ['revision_id']
 
281
    
 
282
    def run(self, revision_id):
 
283
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
284
 
 
285
 
 
286
class cmd_revno(Command):
 
287
    """Show current revision number.
 
288
 
 
289
    This is equal to the number of revisions on this branch."""
 
290
    def run(self):
 
291
        print Branch('.').revno()
 
292
 
 
293
    
 
294
class cmd_add(Command):
 
295
    """Add specified files or directories.
 
296
 
 
297
    In non-recursive mode, all the named items are added, regardless
 
298
    of whether they were previously ignored.  A warning is given if
 
299
    any of the named files are already versioned.
 
300
 
 
301
    In recursive mode (the default), files are treated the same way
 
302
    but the behaviour for directories is different.  Directories that
 
303
    are already versioned do not give a warning.  All directories,
 
304
    whether already versioned or not, are searched for files or
 
305
    subdirectories that are neither versioned or ignored, and these
 
306
    are added.  This search proceeds recursively into versioned
 
307
    directories.
 
308
 
 
309
    Therefore simply saying 'bzr add .' will version all files that
 
310
    are currently unknown.
 
311
 
 
312
    TODO: Perhaps adding a file whose directly is not versioned should
 
313
    recursively add that parent, rather than giving an error?
 
314
    """
 
315
    takes_args = ['file+']
 
316
    takes_options = ['verbose', 'no-recurse']
 
317
    
 
318
    def run(self, file_list, verbose=False, no_recurse=False):
 
319
        bzrlib.add.smart_add(file_list, verbose, not no_recurse)
 
320
 
 
321
 
 
322
class cmd_relpath(Command):
 
323
    """Show path of a file relative to root"""
 
324
    takes_args = ['filename']
 
325
    hidden = True
 
326
    
 
327
    def run(self, filename):
 
328
        print Branch(filename).relpath(filename)
 
329
 
 
330
 
 
331
 
 
332
class cmd_inventory(Command):
 
333
    """Show inventory of the current working copy or a revision."""
 
334
    takes_options = ['revision', 'show-ids']
 
335
    
 
336
    def run(self, revision=None, show_ids=False):
 
337
        b = Branch('.')
 
338
        if revision == None:
 
339
            inv = b.read_working_inventory()
 
340
        else:
 
341
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
342
 
 
343
        for path, entry in inv.entries():
 
344
            if show_ids:
 
345
                print '%-50s %s' % (path, entry.file_id)
 
346
            else:
 
347
                print path
 
348
 
 
349
 
 
350
class cmd_move(Command):
 
351
    """Move files to a different directory.
 
352
 
 
353
    examples:
 
354
        bzr move *.txt doc
 
355
 
 
356
    The destination must be a versioned directory in the same branch.
 
357
    """
 
358
    takes_args = ['source$', 'dest']
 
359
    def run(self, source_list, dest):
 
360
        b = Branch('.')
 
361
 
 
362
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
363
 
 
364
 
 
365
class cmd_rename(Command):
 
366
    """Change the name of an entry.
 
367
 
 
368
    examples:
 
369
      bzr rename frob.c frobber.c
 
370
      bzr rename src/frob.c lib/frob.c
 
371
 
 
372
    It is an error if the destination name exists.
 
373
 
 
374
    See also the 'move' command, which moves files into a different
 
375
    directory without changing their name.
 
376
 
 
377
    TODO: Some way to rename multiple files without invoking bzr for each
 
378
    one?"""
 
379
    takes_args = ['from_name', 'to_name']
 
380
    
 
381
    def run(self, from_name, to_name):
 
382
        b = Branch('.')
 
383
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
384
 
 
385
 
 
386
 
 
387
class cmd_renames(Command):
 
388
    """Show list of renamed files.
 
389
 
 
390
    TODO: Option to show renames between two historical versions.
 
391
 
 
392
    TODO: Only show renames under dir, rather than in the whole branch.
 
393
    """
 
394
    takes_args = ['dir?']
 
395
 
 
396
    def run(self, dir='.'):
 
397
        b = Branch(dir)
 
398
        old_inv = b.basis_tree().inventory
 
399
        new_inv = b.read_working_inventory()
 
400
 
 
401
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
402
        renames.sort()
 
403
        for old_name, new_name in renames:
 
404
            print "%s => %s" % (old_name, new_name)        
 
405
 
 
406
 
 
407
class cmd_info(Command):
 
408
    """Show statistical information about a branch."""
 
409
    takes_args = ['branch?']
 
410
    
 
411
    def run(self, branch=None):
 
412
        import info
 
413
 
 
414
        from branch import find_branch
 
415
        b = find_branch(branch)
 
416
        info.show_info(b)
 
417
 
 
418
 
 
419
class cmd_remove(Command):
 
420
    """Make a file unversioned.
 
421
 
 
422
    This makes bzr stop tracking changes to a versioned file.  It does
 
423
    not delete the working copy.
 
424
    """
 
425
    takes_args = ['file+']
 
426
    takes_options = ['verbose']
 
427
    
 
428
    def run(self, file_list, verbose=False):
 
429
        b = Branch(file_list[0])
 
430
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
431
 
 
432
 
 
433
class cmd_file_id(Command):
 
434
    """Print file_id of a particular file or directory.
 
435
 
 
436
    The file_id is assigned when the file is first added and remains the
 
437
    same through all revisions where the file exists, even when it is
 
438
    moved or renamed.
 
439
    """
 
440
    hidden = True
 
441
    takes_args = ['filename']
 
442
    def run(self, filename):
 
443
        b = Branch(filename)
 
444
        i = b.inventory.path2id(b.relpath(filename))
 
445
        if i == None:
 
446
            bailout("%r is not a versioned file" % filename)
 
447
        else:
 
448
            print i
 
449
 
 
450
 
 
451
class cmd_file_path(Command):
 
452
    """Print path of file_ids to a file or directory.
 
453
 
 
454
    This prints one line for each directory down to the target,
 
455
    starting at the branch root."""
 
456
    hidden = True
 
457
    takes_args = ['filename']
 
458
    def run(self, filename):
 
459
        b = Branch(filename)
 
460
        inv = b.inventory
 
461
        fid = inv.path2id(b.relpath(filename))
 
462
        if fid == None:
 
463
            bailout("%r is not a versioned file" % filename)
 
464
        for fip in inv.get_idpath(fid):
 
465
            print fip
 
466
 
 
467
 
 
468
class cmd_revision_history(Command):
 
469
    """Display list of revision ids on this branch."""
 
470
    hidden = True
 
471
    def run(self):
 
472
        for patchid in Branch('.').revision_history():
 
473
            print patchid
 
474
 
 
475
 
 
476
class cmd_directories(Command):
 
477
    """Display list of versioned directories in this branch."""
 
478
    def run(self):
 
479
        for name, ie in Branch('.').read_working_inventory().directories():
 
480
            if name == '':
 
481
                print '.'
 
482
            else:
 
483
                print name
 
484
 
 
485
 
 
486
class cmd_init(Command):
 
487
    """Make a directory into a versioned branch.
 
488
 
 
489
    Use this to create an empty branch, or before importing an
 
490
    existing project.
 
491
 
 
492
    Recipe for importing a tree of files:
 
493
        cd ~/project
 
494
        bzr init
 
495
        bzr add -v .
 
496
        bzr status
 
497
        bzr commit -m 'imported project'
 
498
    """
 
499
    def run(self):
 
500
        Branch('.', init=True)
 
501
 
 
502
 
 
503
class cmd_diff(Command):
 
504
    """Show differences in working tree.
 
505
    
 
506
    If files are listed, only the changes in those files are listed.
 
507
    Otherwise, all changes for the tree are listed.
 
508
 
 
509
    TODO: Given two revision arguments, show the difference between them.
 
510
 
 
511
    TODO: Allow diff across branches.
 
512
 
 
513
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
514
          or a graphical diff.
 
515
 
 
516
    TODO: Python difflib is not exactly the same as unidiff; should
 
517
          either fix it up or prefer to use an external diff.
 
518
 
 
519
    TODO: If a directory is given, diff everything under that.
 
520
 
 
521
    TODO: Selected-file diff is inefficient and doesn't show you
 
522
          deleted files.
 
523
 
 
524
    TODO: This probably handles non-Unix newlines poorly.
 
525
    """
 
526
    
 
527
    takes_args = ['file*']
 
528
    takes_options = ['revision', 'diff-options']
 
529
    aliases = ['di']
 
530
 
 
531
    def run(self, revision=None, file_list=None, diff_options=None):
 
532
        from bzrlib.diff import show_diff
 
533
        from bzrlib import find_branch
 
534
 
 
535
        if file_list:
 
536
            b = find_branch(file_list[0])
 
537
            file_list = [b.relpath(f) for f in file_list]
 
538
            if file_list == ['']:
 
539
                # just pointing to top-of-tree
 
540
                file_list = None
 
541
        else:
 
542
            b = Branch('.')
 
543
    
 
544
        show_diff(b, revision, specific_files=file_list,
 
545
                  external_diff_options=diff_options)
 
546
 
 
547
 
 
548
        
 
549
 
 
550
 
 
551
class cmd_deleted(Command):
 
552
    """List files deleted in the working tree.
 
553
 
 
554
    TODO: Show files deleted since a previous revision, or between two revisions.
 
555
    """
 
556
    def run(self, show_ids=False):
 
557
        b = Branch('.')
 
558
        old = b.basis_tree()
 
559
        new = b.working_tree()
 
560
 
 
561
        ## TODO: Much more efficient way to do this: read in new
 
562
        ## directories with readdir, rather than stating each one.  Same
 
563
        ## level of effort but possibly much less IO.  (Or possibly not,
 
564
        ## if the directories are very large...)
 
565
 
 
566
        for path, ie in old.inventory.iter_entries():
 
567
            if not new.has_id(ie.file_id):
 
568
                if show_ids:
 
569
                    print '%-50s %s' % (path, ie.file_id)
 
570
                else:
 
571
                    print path
 
572
 
 
573
 
 
574
class cmd_modified(Command):
 
575
    """List files modified in working tree."""
 
576
    hidden = True
 
577
    def run(self):
 
578
        import statcache
 
579
        b = Branch('.')
 
580
        inv = b.read_working_inventory()
 
581
        sc = statcache.update_cache(b, inv)
 
582
        basis = b.basis_tree()
 
583
        basis_inv = basis.inventory
 
584
        
 
585
        # We used to do this through iter_entries(), but that's slow
 
586
        # when most of the files are unmodified, as is usually the
 
587
        # case.  So instead we iterate by inventory entry, and only
 
588
        # calculate paths as necessary.
 
589
 
 
590
        for file_id in basis_inv:
 
591
            cacheentry = sc.get(file_id)
 
592
            if not cacheentry:                 # deleted
 
593
                continue
 
594
            ie = basis_inv[file_id]
 
595
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
596
                path = inv.id2path(file_id)
 
597
                print path
 
598
 
 
599
 
 
600
 
 
601
class cmd_added(Command):
 
602
    """List files added in working tree."""
 
603
    hidden = True
 
604
    def run(self):
 
605
        b = Branch('.')
 
606
        wt = b.working_tree()
 
607
        basis_inv = b.basis_tree().inventory
 
608
        inv = wt.inventory
 
609
        for file_id in inv:
 
610
            if file_id in basis_inv:
 
611
                continue
 
612
            path = inv.id2path(file_id)
 
613
            if not os.access(b.abspath(path), os.F_OK):
 
614
                continue
 
615
            print path
 
616
                
 
617
        
 
618
 
 
619
class cmd_root(Command):
 
620
    """Show the tree root directory.
 
621
 
 
622
    The root is the nearest enclosing directory with a .bzr control
 
623
    directory."""
 
624
    takes_args = ['filename?']
 
625
    def run(self, filename=None):
 
626
        """Print the branch root."""
 
627
        from branch import find_branch
 
628
        b = find_branch(filename)
 
629
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
630
 
 
631
 
 
632
class cmd_log(Command):
 
633
    """Show log of this branch.
 
634
 
 
635
    To request a range of logs, you can use the command -r begin:end
 
636
    -r revision requests a specific revision, -r :end or -r begin: are
 
637
    also valid.
 
638
 
 
639
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
640
  
 
641
    """
 
642
 
 
643
    takes_args = ['filename?']
 
644
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
 
645
    
 
646
    def run(self, filename=None, timezone='original',
 
647
            verbose=False,
 
648
            show_ids=False,
 
649
            forward=False,
 
650
            revision=None):
 
651
        from bzrlib import show_log, find_branch
 
652
        import codecs
 
653
 
 
654
        direction = (forward and 'forward') or 'reverse'
 
655
        
 
656
        if filename:
 
657
            b = find_branch(filename)
 
658
            fp = b.relpath(filename)
 
659
            if fp:
 
660
                file_id = b.read_working_inventory().path2id(fp)
 
661
            else:
 
662
                file_id = None  # points to branch root
 
663
        else:
 
664
            b = find_branch('.')
 
665
            file_id = None
 
666
 
 
667
        if revision == None:
 
668
            revision = [None, None]
 
669
        elif isinstance(revision, int):
 
670
            revision = [revision, revision]
 
671
        else:
 
672
            # pair of revisions?
 
673
            pass
 
674
            
 
675
        assert len(revision) == 2
 
676
 
 
677
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
678
 
 
679
        # use 'replace' so that we don't abort if trying to write out
 
680
        # in e.g. the default C locale.
 
681
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
682
 
 
683
        show_log(b, file_id,
 
684
                 show_timezone=timezone,
 
685
                 verbose=verbose,
 
686
                 show_ids=show_ids,
 
687
                 to_file=outf,
 
688
                 direction=direction,
 
689
                 start_revision=revision[0],
 
690
                 end_revision=revision[1])
 
691
 
 
692
 
 
693
 
 
694
class cmd_touching_revisions(Command):
 
695
    """Return revision-ids which affected a particular file.
 
696
 
 
697
    A more user-friendly interface is "bzr log FILE"."""
 
698
    hidden = True
 
699
    takes_args = ["filename"]
 
700
    def run(self, filename):
 
701
        b = Branch(filename)
 
702
        inv = b.read_working_inventory()
 
703
        file_id = inv.path2id(b.relpath(filename))
 
704
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
705
            print "%6d %s" % (revno, what)
 
706
 
 
707
 
 
708
class cmd_ls(Command):
 
709
    """List files in a tree.
 
710
 
 
711
    TODO: Take a revision or remote path and list that tree instead.
 
712
    """
 
713
    hidden = True
 
714
    def run(self, revision=None, verbose=False):
 
715
        b = Branch('.')
 
716
        if revision == None:
 
717
            tree = b.working_tree()
 
718
        else:
 
719
            tree = b.revision_tree(b.lookup_revision(revision))
 
720
 
 
721
        for fp, fc, kind, fid in tree.list_files():
 
722
            if verbose:
 
723
                if kind == 'directory':
 
724
                    kindch = '/'
 
725
                elif kind == 'file':
 
726
                    kindch = ''
 
727
                else:
 
728
                    kindch = '???'
 
729
 
 
730
                print '%-8s %s%s' % (fc, fp, kindch)
 
731
            else:
 
732
                print fp
 
733
 
 
734
 
 
735
 
 
736
class cmd_unknowns(Command):
 
737
    """List unknown files"""
 
738
    def run(self):
 
739
        for f in Branch('.').unknowns():
 
740
            print quotefn(f)
 
741
 
 
742
 
 
743
 
 
744
class cmd_ignore(Command):
 
745
    """Ignore a command or pattern
 
746
 
 
747
    To remove patterns from the ignore list, edit the .bzrignore file.
 
748
 
 
749
    If the pattern contains a slash, it is compared to the whole path
 
750
    from the branch root.  Otherwise, it is comapred to only the last
 
751
    component of the path.
 
752
 
 
753
    Ignore patterns are case-insensitive on case-insensitive systems.
 
754
 
 
755
    Note: wildcards must be quoted from the shell on Unix.
 
756
 
 
757
    examples:
 
758
        bzr ignore ./Makefile
 
759
        bzr ignore '*.class'
 
760
    """
 
761
    takes_args = ['name_pattern']
 
762
    
 
763
    def run(self, name_pattern):
 
764
        from bzrlib.atomicfile import AtomicFile
 
765
        import os.path
 
766
 
 
767
        b = Branch('.')
 
768
        ifn = b.abspath('.bzrignore')
 
769
 
 
770
        if os.path.exists(ifn):
 
771
            f = open(ifn, 'rt')
 
772
            try:
 
773
                igns = f.read().decode('utf-8')
 
774
            finally:
 
775
                f.close()
 
776
        else:
 
777
            igns = ''
 
778
 
 
779
        # TODO: If the file already uses crlf-style termination, maybe
 
780
        # we should use that for the newly added lines?
 
781
 
 
782
        if igns and igns[-1] != '\n':
 
783
            igns += '\n'
 
784
        igns += name_pattern + '\n'
 
785
 
 
786
        try:
 
787
            f = AtomicFile(ifn, 'wt')
 
788
            f.write(igns.encode('utf-8'))
 
789
            f.commit()
 
790
        finally:
 
791
            f.close()
 
792
 
 
793
        inv = b.working_tree().inventory
 
794
        if inv.path2id('.bzrignore'):
 
795
            mutter('.bzrignore is already versioned')
 
796
        else:
 
797
            mutter('need to make new .bzrignore file versioned')
 
798
            b.add(['.bzrignore'])
 
799
 
 
800
 
 
801
 
 
802
class cmd_ignored(Command):
 
803
    """List ignored files and the patterns that matched them.
 
804
 
 
805
    See also: bzr ignore"""
 
806
    def run(self):
 
807
        tree = Branch('.').working_tree()
 
808
        for path, file_class, kind, file_id in tree.list_files():
 
809
            if file_class != 'I':
 
810
                continue
 
811
            ## XXX: Slightly inefficient since this was already calculated
 
812
            pat = tree.is_ignored(path)
 
813
            print '%-50s %s' % (path, pat)
 
814
 
 
815
 
 
816
class cmd_lookup_revision(Command):
 
817
    """Lookup the revision-id from a revision-number
 
818
 
 
819
    example:
 
820
        bzr lookup-revision 33
 
821
    """
 
822
    hidden = True
 
823
    takes_args = ['revno']
 
824
    
 
825
    def run(self, revno):
 
826
        try:
 
827
            revno = int(revno)
 
828
        except ValueError:
 
829
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
830
 
 
831
        print Branch('.').lookup_revision(revno)
 
832
 
 
833
 
 
834
class cmd_export(Command):
 
835
    """Export past revision to destination directory.
 
836
 
 
837
    If no revision is specified this exports the last committed revision."""
 
838
    takes_args = ['dest']
 
839
    takes_options = ['revision']
 
840
    def run(self, dest, revision=None):
 
841
        b = Branch('.')
 
842
        if revision == None:
 
843
            rh = b.revision_history()[-1]
 
844
        else:
 
845
            rh = b.lookup_revision(int(revision))
 
846
        t = b.revision_tree(rh)
 
847
        t.export(dest)
 
848
 
 
849
 
 
850
class cmd_cat(Command):
 
851
    """Write a file's text from a previous revision."""
 
852
 
 
853
    takes_options = ['revision']
 
854
    takes_args = ['filename']
 
855
 
 
856
    def run(self, filename, revision=None):
 
857
        if revision == None:
 
858
            raise BzrCommandError("bzr cat requires a revision number")
 
859
        b = Branch('.')
 
860
        b.print_file(b.relpath(filename), int(revision))
 
861
 
 
862
 
 
863
class cmd_local_time_offset(Command):
 
864
    """Show the offset in seconds from GMT to local time."""
 
865
    hidden = True    
 
866
    def run(self):
 
867
        print bzrlib.osutils.local_time_offset()
 
868
 
 
869
 
 
870
 
 
871
class cmd_commit(Command):
 
872
    """Commit changes into a new revision.
 
873
 
 
874
    If selected files are specified, only changes to those files are
 
875
    committed.  If a directory is specified then its contents are also
 
876
    committed.
 
877
 
 
878
    A selected-file commit may fail in some cases where the committed
 
879
    tree would be invalid, such as trying to commit a file in a
 
880
    newly-added directory that is not itself committed.
 
881
 
 
882
    TODO: Run hooks on tree to-be-committed, and after commit.
 
883
 
 
884
    TODO: Strict commit that fails if there are unknown or deleted files.
 
885
    """
 
886
    takes_args = ['selected*']
 
887
    takes_options = ['message', 'file', 'verbose']
 
888
    aliases = ['ci', 'checkin']
 
889
 
 
890
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
891
        from bzrlib.commit import commit
 
892
 
 
893
        ## Warning: shadows builtin file()
 
894
        if not message and not file:
 
895
            raise BzrCommandError("please specify a commit message",
 
896
                                  ["use either --message or --file"])
 
897
        elif message and file:
 
898
            raise BzrCommandError("please specify either --message or --file")
 
899
        
 
900
        if file:
 
901
            import codecs
 
902
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
903
 
 
904
        b = Branch('.')
 
905
        commit(b, message, verbose=verbose, specific_files=selected_list)
 
906
 
 
907
 
 
908
class cmd_check(Command):
 
909
    """Validate consistency of branch history.
 
910
 
 
911
    This command checks various invariants about the branch storage to
 
912
    detect data corruption or bzr bugs.
 
913
    """
 
914
    takes_args = ['dir?']
 
915
    def run(self, dir='.'):
 
916
        import bzrlib.check
 
917
        bzrlib.check.check(Branch(dir))
 
918
 
 
919
 
 
920
 
 
921
class cmd_whoami(Command):
 
922
    """Show bzr user id."""
 
923
    takes_options = ['email']
 
924
    
 
925
    def run(self, email=False):
 
926
        if email:
 
927
            print bzrlib.osutils.user_email()
 
928
        else:
 
929
            print bzrlib.osutils.username()
 
930
 
 
931
 
 
932
class cmd_selftest(Command):
 
933
    """Run internal test suite"""
 
934
    hidden = True
 
935
    def run(self):
 
936
        from bzrlib.selftest import selftest
 
937
        if selftest():
 
938
            return 0
 
939
        else:
 
940
            return 1
 
941
 
 
942
 
 
943
 
 
944
class cmd_version(Command):
 
945
    """Show version of bzr"""
 
946
    def run(self):
 
947
        show_version()
 
948
 
 
949
def show_version():
 
950
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
951
    # is bzrlib itself in a branch?
 
952
    bzrrev = bzrlib.get_bzr_revision()
 
953
    if bzrrev:
 
954
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
955
    print bzrlib.__copyright__
 
956
    print "http://bazaar-ng.org/"
 
957
    print
 
958
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
959
    print "you may use, modify and redistribute it under the terms of the GNU"
 
960
    print "General Public License version 2 or later."
 
961
 
 
962
 
 
963
class cmd_rocks(Command):
 
964
    """Statement of optimism."""
 
965
    hidden = True
 
966
    def run(self):
 
967
        print "it sure does!"
312
968
 
313
969
def parse_spec(spec):
314
970
    """
320
976
    ['..', -1]
321
977
    >>> parse_spec("../f/@35")
322
978
    ['../f', 35]
323
 
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
 
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
325
979
    """
326
980
    if spec is None:
327
981
        return [None, None]
331
985
        if parsed[1] == "":
332
986
            parsed[1] = -1
333
987
        else:
334
 
            try:
335
 
                parsed[1] = int(parsed[1])
336
 
            except ValueError:
337
 
                pass # We can allow stuff like ./@revid:blahblahblah
338
 
            else:
339
 
                assert parsed[1] >=0
 
988
            parsed[1] = int(parsed[1])
 
989
            assert parsed[1] >=0
340
990
    else:
341
991
        parsed = [spec, None]
342
992
    return parsed
343
993
 
 
994
class cmd_merge(Command):
 
995
    """Perform a three-way merge of trees.
 
996
    
 
997
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
998
    are specified using standard paths or urls.  No component of a directory
 
999
    path may begin with '@'.
 
1000
    
 
1001
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1002
 
 
1003
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1004
    branch directory and revno is the revision within that branch.  If no revno
 
1005
    is specified, the latest revision is used.
 
1006
 
 
1007
    Revision examples: './@127', 'foo/@', '../@1'
 
1008
 
 
1009
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1010
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1011
    as the BASE.
 
1012
    """
 
1013
    takes_args = ['other_spec', 'base_spec?']
 
1014
 
 
1015
    def run(self, other_spec, base_spec=None):
 
1016
        from bzrlib.merge import merge
 
1017
        merge(parse_spec(other_spec), parse_spec(base_spec))
 
1018
 
 
1019
 
 
1020
class cmd_revert(Command):
 
1021
    """
 
1022
    Reverse all changes since the last commit.  Only versioned files are
 
1023
    affected.
 
1024
    """
 
1025
    takes_options = ['revision']
 
1026
 
 
1027
    def run(self, revision=-1):
 
1028
        merge.merge(('.', revision), parse_spec('.'), no_changes=False,
 
1029
                    ignore_zero=True)
 
1030
 
 
1031
 
 
1032
class cmd_assert_fail(Command):
 
1033
    """Test reporting of assertion failures"""
 
1034
    hidden = True
 
1035
    def run(self):
 
1036
        assert False, "always fails"
 
1037
 
 
1038
 
 
1039
class cmd_help(Command):
 
1040
    """Show help on a command or other topic.
 
1041
 
 
1042
    For a list of all available commands, say 'bzr help commands'."""
 
1043
    takes_args = ['topic?']
 
1044
    aliases = ['?']
 
1045
    
 
1046
    def run(self, topic=None):
 
1047
        import help
 
1048
        help.help(topic)
 
1049
 
 
1050
 
 
1051
class cmd_update_stat_cache(Command):
 
1052
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
1053
 
 
1054
    For testing only."""
 
1055
    hidden = True
 
1056
    def run(self):
 
1057
        import statcache
 
1058
        b = Branch('.')
 
1059
        statcache.update_cache(b.base, b.read_working_inventory())
344
1060
 
345
1061
 
346
1062
 
352
1068
    'diff-options':           str,
353
1069
    'help':                   None,
354
1070
    'file':                   unicode,
355
 
    'force':                  None,
356
 
    'format':                 unicode,
357
1071
    'forward':                None,
358
1072
    'message':                unicode,
359
1073
    'no-recurse':             None,
360
1074
    'profile':                None,
361
1075
    'revision':               _parse_revision_str,
362
 
    'short':                  None,
363
1076
    'show-ids':               None,
364
1077
    'timezone':               str,
365
1078
    'verbose':                None,
366
1079
    'version':                None,
367
1080
    'email':                  None,
368
 
    'unchanged':              None,
369
 
    'update':                 None,
370
 
    'long':                   None,
371
 
    'root':                   str,
372
 
    'no-backup':              None,
373
 
    'merge-type':             get_merge_type,
374
 
    'pattern':                str,
375
1081
    }
376
1082
 
377
1083
SHORT_OPTIONS = {
380
1086
    'm':                      'message',
381
1087
    'r':                      'revision',
382
1088
    'v':                      'verbose',
383
 
    'l':                      'long',
384
1089
}
385
1090
 
386
1091
 
394
1099
 
395
1100
    >>> parse_args('--help'.split())
396
1101
    ([], {'help': True})
397
 
    >>> parse_args('help -- --invalidcmd'.split())
398
 
    (['help', '--invalidcmd'], {})
399
1102
    >>> parse_args('--version'.split())
400
1103
    ([], {'version': True})
401
1104
    >>> parse_args('status --all'.split())
402
1105
    (['status'], {'all': True})
403
1106
    >>> parse_args('commit --message=biter'.split())
404
1107
    (['commit'], {'message': u'biter'})
405
 
    >>> parse_args('log -r 500'.split())
406
 
    (['log'], {'revision': [500]})
407
 
    >>> parse_args('log -r500..600'.split())
408
 
    (['log'], {'revision': [500, 600]})
409
 
    >>> parse_args('log -vr500..600'.split())
410
 
    (['log'], {'verbose': True, 'revision': [500, 600]})
411
 
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
 
    (['log'], {'revision': ['v500', 600]})
413
1108
    """
414
1109
    args = []
415
1110
    opts = {}
416
1111
 
417
 
    argsover = False
 
1112
    # TODO: Maybe handle '--' to end options?
 
1113
 
418
1114
    while argv:
419
1115
        a = argv.pop(0)
420
 
        if not argsover and a[0] == '-':
 
1116
        if a[0] == '-':
421
1117
            # option names must not be unicode
422
1118
            a = str(a)
423
1119
            optarg = None
424
1120
            if a[1] == '-':
425
 
                if a == '--':
426
 
                    # We've received a standalone -- No more flags
427
 
                    argsover = True
428
 
                    continue
429
1121
                mutter("  got option %r" % a)
430
1122
                if '=' in a:
431
1123
                    optname, optarg = a[2:].split('=', 1)
432
1124
                else:
433
1125
                    optname = a[2:]
434
1126
                if optname not in OPTIONS:
435
 
                    raise BzrError('unknown long option %r' % a)
 
1127
                    bailout('unknown long option %r' % a)
436
1128
            else:
437
1129
                shortopt = a[1:]
438
 
                if shortopt in SHORT_OPTIONS:
439
 
                    # Multi-character options must have a space to delimit
440
 
                    # their value
441
 
                    optname = SHORT_OPTIONS[shortopt]
442
 
                else:
443
 
                    # Single character short options, can be chained,
444
 
                    # and have their value appended to their name
445
 
                    shortopt = a[1:2]
446
 
                    if shortopt not in SHORT_OPTIONS:
447
 
                        # We didn't find the multi-character name, and we
448
 
                        # didn't find the single char name
449
 
                        raise BzrError('unknown short option %r' % a)
450
 
                    optname = SHORT_OPTIONS[shortopt]
451
 
 
452
 
                    if a[2:]:
453
 
                        # There are extra things on this option
454
 
                        # see if it is the value, or if it is another
455
 
                        # short option
456
 
                        optargfn = OPTIONS[optname]
457
 
                        if optargfn is None:
458
 
                            # This option does not take an argument, so the
459
 
                            # next entry is another short option, pack it back
460
 
                            # into the list
461
 
                            argv.insert(0, '-' + a[2:])
462
 
                        else:
463
 
                            # This option takes an argument, so pack it
464
 
                            # into the array
465
 
                            optarg = a[2:]
 
1130
                if shortopt not in SHORT_OPTIONS:
 
1131
                    bailout('unknown short option %r' % a)
 
1132
                optname = SHORT_OPTIONS[shortopt]
466
1133
            
467
1134
            if optname in opts:
468
1135
                # XXX: Do we ever want to support this, e.g. for -r?
469
 
                raise BzrError('repeated option %r' % a)
 
1136
                bailout('repeated option %r' % a)
470
1137
                
471
1138
            optargfn = OPTIONS[optname]
472
1139
            if optargfn:
473
1140
                if optarg == None:
474
1141
                    if not argv:
475
 
                        raise BzrError('option %r needs an argument' % a)
 
1142
                        bailout('option %r needs an argument' % a)
476
1143
                    else:
477
1144
                        optarg = argv.pop(0)
478
1145
                opts[optname] = optargfn(optarg)
479
1146
            else:
480
1147
                if optarg != None:
481
 
                    raise BzrError('option %r takes no argument' % optname)
 
1148
                    bailout('option %r takes no argument' % optname)
482
1149
                opts[optname] = True
483
1150
        else:
484
1151
            args.append(a)
533
1200
 
534
1201
 
535
1202
 
536
 
def apply_profiled(the_callable, *args, **kwargs):
537
 
    import hotshot
538
 
    import tempfile
539
 
    pffileno, pfname = tempfile.mkstemp()
540
 
    try:
541
 
        prof = hotshot.Profile(pfname)
542
 
        try:
543
 
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
544
 
        finally:
545
 
            prof.close()
546
 
 
547
 
        import hotshot.stats
548
 
        stats = hotshot.stats.load(pfname)
549
 
        #stats.strip_dirs()
550
 
        stats.sort_stats('time')
551
 
        ## XXX: Might like to write to stderr or the trace file instead but
552
 
        ## print_stats seems hardcoded to stdout
553
 
        stats.print_stats(20)
554
 
 
555
 
        return ret
556
 
    finally:
557
 
        os.close(pffileno)
558
 
        os.remove(pfname)
559
 
 
560
 
 
561
1203
def run_bzr(argv):
562
1204
    """Execute a command.
563
1205
 
564
1206
    This is similar to main(), but without all the trappings for
565
1207
    logging and error handling.  
566
 
    
567
 
    argv
568
 
       The command-line arguments, without the program name from argv[0]
569
 
    
570
 
    Returns a command status or raises an exception.
571
 
 
572
 
    Special master options: these must come before the command because
573
 
    they control how the command is interpreted.
574
 
 
575
 
    --no-plugins
576
 
        Do not load plugin modules at all
577
 
 
578
 
    --builtin
579
 
        Only use builtin commands.  (Plugins are still allowed to change
580
 
        other behaviour.)
581
 
 
582
 
    --profile
583
 
        Run under the Python profiler.
584
1208
    """
585
 
    
586
1209
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
587
 
 
588
 
    opt_profile = opt_no_plugins = opt_builtin = False
589
 
 
590
 
    # --no-plugins is handled specially at a very early stage. We need
591
 
    # to load plugins before doing other command parsing so that they
592
 
    # can override commands, but this needs to happen first.
593
 
 
594
 
    for a in argv:
595
 
        if a == '--profile':
596
 
            opt_profile = True
597
 
        elif a == '--no-plugins':
598
 
            opt_no_plugins = True
599
 
        elif a == '--builtin':
600
 
            opt_builtin = True
601
 
        else:
602
 
            break
603
 
        argv.remove(a)
604
 
 
605
 
    if (not argv) or (argv[0] == '--help'):
606
 
        from bzrlib.help import help
607
 
        if len(argv) > 1:
608
 
            help(argv[1])
609
 
        else:
610
 
            help()
611
 
        return 0
612
 
 
613
 
    if argv[0] == '--version':
614
 
        from bzrlib.builtins import show_version
615
 
        show_version()
616
 
        return 0
617
 
        
618
 
    if not opt_no_plugins:
619
 
        from bzrlib.plugin import load_plugins
620
 
        load_plugins()
621
 
 
622
 
    cmd = str(argv.pop(0))
623
 
 
624
 
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
625
 
 
626
 
    if opt_profile:
627
 
        ret = apply_profiled(cmd_obj.run_argv, argv)
628
 
    else:
629
 
        ret = cmd_obj.run_argv(argv)
630
 
    return ret or 0
 
1210
    
 
1211
    try:
 
1212
        args, opts = parse_args(argv[1:])
 
1213
        if 'help' in opts:
 
1214
            import help
 
1215
            if args:
 
1216
                help.help(args[0])
 
1217
            else:
 
1218
                help.help()
 
1219
            return 0
 
1220
        elif 'version' in opts:
 
1221
            show_version()
 
1222
            return 0
 
1223
        cmd = str(args.pop(0))
 
1224
    except IndexError:
 
1225
        import help
 
1226
        help.help()
 
1227
        return 1
 
1228
          
 
1229
 
 
1230
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
1231
 
 
1232
    # global option
 
1233
    if 'profile' in opts:
 
1234
        profile = True
 
1235
        del opts['profile']
 
1236
    else:
 
1237
        profile = False
 
1238
 
 
1239
    # check options are reasonable
 
1240
    allowed = cmd_class.takes_options
 
1241
    for oname in opts:
 
1242
        if oname not in allowed:
 
1243
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1244
                                  % (oname, cmd))
 
1245
 
 
1246
    # mix arguments and options into one dictionary
 
1247
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1248
    cmdopts = {}
 
1249
    for k, v in opts.items():
 
1250
        cmdopts[k.replace('-', '_')] = v
 
1251
 
 
1252
    if profile:
 
1253
        import hotshot, tempfile
 
1254
        pffileno, pfname = tempfile.mkstemp()
 
1255
        try:
 
1256
            prof = hotshot.Profile(pfname)
 
1257
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1258
            prof.close()
 
1259
 
 
1260
            import hotshot.stats
 
1261
            stats = hotshot.stats.load(pfname)
 
1262
            #stats.strip_dirs()
 
1263
            stats.sort_stats('time')
 
1264
            ## XXX: Might like to write to stderr or the trace file instead but
 
1265
            ## print_stats seems hardcoded to stdout
 
1266
            stats.print_stats(20)
 
1267
            
 
1268
            return ret.status
 
1269
 
 
1270
        finally:
 
1271
            os.close(pffileno)
 
1272
            os.remove(pfname)
 
1273
    else:
 
1274
        return cmd_class(cmdopts, cmdargs).status 
 
1275
 
 
1276
 
 
1277
def _report_exception(summary, quiet=False):
 
1278
    import traceback
 
1279
    log_error('bzr: ' + summary)
 
1280
    bzrlib.trace.log_exception()
 
1281
 
 
1282
    if not quiet:
 
1283
        tb = sys.exc_info()[2]
 
1284
        exinfo = traceback.extract_tb(tb)
 
1285
        if exinfo:
 
1286
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1287
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1288
 
631
1289
 
632
1290
 
633
1291
def main(argv):
634
 
    import bzrlib.ui
635
 
    bzrlib.trace.log_startup(argv)
636
 
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
 
1292
    import errno
 
1293
    
 
1294
    bzrlib.open_tracefile(argv)
637
1295
 
638
1296
    try:
639
1297
        try:
640
 
            return run_bzr(argv[1:])
641
 
        finally:
642
 
            # do this here inside the exception wrappers to catch EPIPE
643
 
            sys.stdout.flush()
644
 
    except BzrCommandError, e:
645
 
        # command line syntax error, etc
646
 
        log_error(str(e))
647
 
        return 1
648
 
    except BzrError, e:
649
 
        bzrlib.trace.log_exception()
650
 
        return 1
651
 
    except AssertionError, e:
652
 
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
653
 
        return 3
654
 
    except KeyboardInterrupt, e:
655
 
        bzrlib.trace.note('interrupted')
656
 
        return 2
657
 
    except Exception, e:
658
 
        import errno
659
 
        if (isinstance(e, IOError) 
660
 
            and hasattr(e, 'errno')
661
 
            and e.errno == errno.EPIPE):
662
 
            bzrlib.trace.note('broken pipe')
663
 
            return 2
664
 
        else:
665
 
            bzrlib.trace.log_exception()
666
 
            return 2
 
1298
            try:
 
1299
                return run_bzr(argv)
 
1300
            finally:
 
1301
                # do this here inside the exception wrappers to catch EPIPE
 
1302
                sys.stdout.flush()
 
1303
        except BzrError, e:
 
1304
            quiet = isinstance(e, (BzrCommandError))
 
1305
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1306
            if len(e.args) > 1:
 
1307
                for h in e.args[1]:
 
1308
                    # some explanation or hints
 
1309
                    log_error('  ' + h)
 
1310
            return 1
 
1311
        except AssertionError, e:
 
1312
            msg = 'assertion failed'
 
1313
            if str(e):
 
1314
                msg += ': ' + str(e)
 
1315
            _report_exception(msg)
 
1316
            return 2
 
1317
        except KeyboardInterrupt, e:
 
1318
            _report_exception('interrupted', quiet=True)
 
1319
            return 2
 
1320
        except Exception, e:
 
1321
            quiet = False
 
1322
            if (isinstance(e, IOError) 
 
1323
                and hasattr(e, 'errno')
 
1324
                and e.errno == errno.EPIPE):
 
1325
                quiet = True
 
1326
                msg = 'broken pipe'
 
1327
            else:
 
1328
                msg = str(e).rstrip('\n')
 
1329
            _report_exception(msg, quiet)
 
1330
            return 2
 
1331
    finally:
 
1332
        bzrlib.trace.close_trace()
667
1333
 
668
1334
 
669
1335
if __name__ == '__main__':