~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

bugfix from Aaron Bentley - bzrlib.graph.max_distance had an off-by-1 error

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
# TODO: Split the command framework away from the actual commands.
19
 
 
20
18
# TODO: probably should say which arguments are candidates for glob
21
19
# expansion on windows and do that at the command level.
22
20
 
34
32
# would help with validation and shell completion.
35
33
 
36
34
 
 
35
 
37
36
import sys
38
37
import os
 
38
from warnings import warn
 
39
from inspect import getdoc
39
40
 
40
41
import bzrlib
41
42
import bzrlib.trace
42
43
from bzrlib.trace import mutter, note, log_error, warning
43
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
44
 
from bzrlib.branch import find_branch
 
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
 
45
from bzrlib.revisionspec import RevisionSpec
45
46
from bzrlib import BZRDIR
46
47
 
47
 
 
48
48
plugin_cmds = {}
49
49
 
50
50
 
58
58
        k_unsquished = k
59
59
    if not plugin_cmds.has_key(k_unsquished):
60
60
        plugin_cmds[k_unsquished] = cmd
 
61
        mutter('registered plugin command %s', k_unsquished)      
61
62
    else:
62
63
        log_error('Two plugins defined the same command: %r' % k)
63
64
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
75
76
def _parse_revision_str(revstr):
76
77
    """This handles a revision string -> revno.
77
78
 
78
 
    This always returns a list.  The list will have one element for 
79
 
 
80
 
    It supports integers directly, but everything else it
81
 
    defers for passing to Branch.get_revision_info()
 
79
    This always returns a list.  The list will have one element for
 
80
    each revision.
82
81
 
83
82
    >>> _parse_revision_str('234')
84
 
    [234]
 
83
    [<RevisionSpec_int 234>]
85
84
    >>> _parse_revision_str('234..567')
86
 
    [234, 567]
 
85
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
87
86
    >>> _parse_revision_str('..')
88
 
    [None, None]
 
87
    [<RevisionSpec None>, <RevisionSpec None>]
89
88
    >>> _parse_revision_str('..234')
90
 
    [None, 234]
 
89
    [<RevisionSpec None>, <RevisionSpec_int 234>]
91
90
    >>> _parse_revision_str('234..')
92
 
    [234, None]
 
91
    [<RevisionSpec_int 234>, <RevisionSpec None>]
93
92
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
94
 
    [234, 456, 789]
 
93
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
95
94
    >>> _parse_revision_str('234....789') # Error?
96
 
    [234, None, 789]
 
95
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
97
96
    >>> _parse_revision_str('revid:test@other.com-234234')
98
 
    ['revid:test@other.com-234234']
 
97
    [<RevisionSpec_revid revid:test@other.com-234234>]
99
98
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
100
 
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
 
99
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
101
100
    >>> _parse_revision_str('revid:test@other.com-234234..23')
102
 
    ['revid:test@other.com-234234', 23]
 
101
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
103
102
    >>> _parse_revision_str('date:2005-04-12')
104
 
    ['date:2005-04-12']
 
103
    [<RevisionSpec_date date:2005-04-12>]
105
104
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
106
 
    ['date:2005-04-12 12:24:33']
 
105
    [<RevisionSpec_date date:2005-04-12 12:24:33>]
107
106
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
108
 
    ['date:2005-04-12T12:24:33']
 
107
    [<RevisionSpec_date date:2005-04-12T12:24:33>]
109
108
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
110
 
    ['date:2005-04-12,12:24:33']
 
109
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
111
110
    >>> _parse_revision_str('-5..23')
112
 
    [-5, 23]
 
111
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
113
112
    >>> _parse_revision_str('-5')
114
 
    [-5]
 
113
    [<RevisionSpec_int -5>]
115
114
    >>> _parse_revision_str('123a')
116
 
    ['123a']
 
115
    Traceback (most recent call last):
 
116
      ...
 
117
    BzrError: No namespace registered for string: '123a'
117
118
    >>> _parse_revision_str('abc')
118
 
    ['abc']
 
119
    Traceback (most recent call last):
 
120
      ...
 
121
    BzrError: No namespace registered for string: 'abc'
119
122
    """
120
123
    import re
121
124
    old_format_re = re.compile('\d*:\d*')
122
125
    m = old_format_re.match(revstr)
 
126
    revs = []
123
127
    if m:
124
128
        warning('Colon separator for revision numbers is deprecated.'
125
129
                ' Use .. instead')
126
 
        revs = []
127
130
        for rev in revstr.split(':'):
128
131
            if rev:
129
 
                revs.append(int(rev))
130
 
            else:
131
 
                revs.append(None)
132
 
        return revs
133
 
    revs = []
134
 
    for x in revstr.split('..'):
135
 
        if not x:
136
 
            revs.append(None)
137
 
        else:
138
 
            try:
139
 
                revs.append(int(x))
140
 
            except ValueError:
141
 
                revs.append(x)
 
132
                revs.append(RevisionSpec(int(rev)))
 
133
            else:
 
134
                revs.append(RevisionSpec(None))
 
135
    else:
 
136
        for x in revstr.split('..'):
 
137
            if not x:
 
138
                revs.append(RevisionSpec(None))
 
139
            else:
 
140
                revs.append(RevisionSpec(x))
142
141
    return revs
143
142
 
144
143
 
154
153
        msg = "No known merge type %s. Supported types are:\n%s" %\
155
154
            (typestring, type_list)
156
155
        raise BzrCommandError(msg)
157
 
    
158
 
 
159
 
def get_merge_type(typestring):
160
 
    """Attempt to find the merge class/factory associated with a string."""
161
 
    from merge import merge_types
162
 
    try:
163
 
        return merge_types[typestring][0]
164
 
    except KeyError:
165
 
        templ = '%s%%7s: %%s' % (' '*12)
166
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
167
 
        type_list = '\n'.join(lines)
168
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
169
 
            (typestring, type_list)
170
 
        raise BzrCommandError(msg)
171
 
    
 
156
 
 
157
 
 
158
def _builtin_commands():
 
159
    import bzrlib.builtins
 
160
    r = {}
 
161
    builtins = bzrlib.builtins.__dict__
 
162
    for name in builtins:
 
163
        if name.startswith("cmd_"):
 
164
            real_name = _unsquish_command_name(name)        
 
165
            r[real_name] = builtins[name]
 
166
    return r
 
167
 
 
168
            
 
169
 
 
170
def builtin_command_names():
 
171
    """Return list of builtin command names."""
 
172
    return _builtin_commands().keys()
 
173
    
 
174
 
 
175
def plugin_command_names():
 
176
    return plugin_cmds.keys()
172
177
 
173
178
 
174
179
def _get_cmd_dict(plugins_override=True):
175
 
    d = {}
176
 
    for k, v in globals().iteritems():
177
 
        if k.startswith("cmd_"):
178
 
            d[_unsquish_command_name(k)] = v
179
 
    # If we didn't load plugins, the plugin_cmds dict will be empty
 
180
    """Return name->class mapping for all commands."""
 
181
    d = _builtin_commands()
180
182
    if plugins_override:
181
183
        d.update(plugin_cmds)
182
 
    else:
183
 
        d2 = plugin_cmds.copy()
184
 
        d2.update(d)
185
 
        d = d2
186
184
    return d
187
185
 
188
186
    
192
190
        yield k,v
193
191
 
194
192
 
195
 
def get_cmd_class(cmd, plugins_override=True):
 
193
def get_cmd_object(cmd_name, plugins_override=True):
196
194
    """Return the canonical name and command class for a command.
 
195
 
 
196
    plugins_override
 
197
        If true, plugin commands can override builtins.
197
198
    """
198
 
    cmd = str(cmd)                      # not unicode
 
199
    from bzrlib.externalcommand import ExternalCommand
 
200
 
 
201
    cmd_name = str(cmd_name)            # not unicode
199
202
 
200
203
    # first look up this command under the specified name
201
204
    cmds = _get_cmd_dict(plugins_override=plugins_override)
202
205
    try:
203
 
        return cmd, cmds[cmd]
 
206
        return cmds[cmd_name]()
204
207
    except KeyError:
205
208
        pass
206
209
 
207
210
    # look for any command which claims this as an alias
208
 
    for cmdname, cmdclass in cmds.iteritems():
209
 
        if cmd in cmdclass.aliases:
210
 
            return cmdname, cmdclass
211
 
 
212
 
    cmdclass = ExternalCommand.find_command(cmd)
213
 
    if cmdclass:
214
 
        return cmd, cmdclass
215
 
 
216
 
    raise BzrCommandError("unknown command %r" % cmd)
 
211
    for real_cmd_name, cmd_class in cmds.iteritems():
 
212
        if cmd_name in cmd_class.aliases:
 
213
            return cmd_class()
 
214
 
 
215
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
216
    if cmd_obj:
 
217
        return cmd_obj
 
218
 
 
219
    raise BzrCommandError("unknown command %r" % cmd_name)
217
220
 
218
221
 
219
222
class Command(object):
220
223
    """Base class for commands.
221
224
 
 
225
    Commands are the heart of the command-line bzr interface.
 
226
 
 
227
    The command object mostly handles the mapping of command-line
 
228
    parameters into one or more bzrlib operations, and of the results
 
229
    into textual output.
 
230
 
 
231
    Commands normally don't have any state.  All their arguments are
 
232
    passed in to the run method.  (Subclasses may take a different
 
233
    policy if the behaviour of the instance needs to depend on e.g. a
 
234
    shell plugin and not just its Python class.)
 
235
 
222
236
    The docstring for an actual command should give a single-line
223
237
    summary, then a complete description of the command.  A grammar
224
238
    description will be inserted.
225
239
 
 
240
    aliases
 
241
        Other accepted names for this command.
 
242
 
226
243
    takes_args
227
244
        List of argument forms, marked with whether they are optional,
228
245
        repeated, etc.
231
248
        List of options that may be given for this command.
232
249
 
233
250
    hidden
234
 
        If true, this command isn't advertised.
 
251
        If true, this command isn't advertised.  This is typically
 
252
        for commands intended for expert users.
235
253
    """
236
254
    aliases = []
237
255
    
240
258
 
241
259
    hidden = False
242
260
    
243
 
    def __init__(self, options, arguments):
244
 
        """Construct and run the command.
245
 
 
246
 
        Sets self.status to the return value of run()."""
247
 
        assert isinstance(options, dict)
248
 
        assert isinstance(arguments, dict)
249
 
        cmdargs = options.copy()
250
 
        cmdargs.update(arguments)
 
261
    def __init__(self):
 
262
        """Construct an instance of this command."""
251
263
        if self.__doc__ == Command.__doc__:
252
 
            from warnings import warn
253
264
            warn("No help message set for %r" % self)
254
 
        self.status = self.run(**cmdargs)
255
 
        if self.status is None:
256
 
            self.status = 0
 
265
 
 
266
 
 
267
    def run_argv(self, argv):
 
268
        """Parse command line and run."""
 
269
        args, opts = parse_args(argv)
 
270
 
 
271
        if 'help' in opts:  # e.g. bzr add --help
 
272
            from bzrlib.help import help_on_command
 
273
            help_on_command(self.name())
 
274
            return 0
 
275
 
 
276
        # check options are reasonable
 
277
        allowed = self.takes_options
 
278
        for oname in opts:
 
279
            if oname not in allowed:
 
280
                raise BzrCommandError("option '--%s' is not allowed for command %r"
 
281
                                      % (oname, self.name()))
 
282
 
 
283
        # mix arguments and options into one dictionary
 
284
        cmdargs = _match_argform(self.name(), self.takes_args, args)
 
285
        cmdopts = {}
 
286
        for k, v in opts.items():
 
287
            cmdopts[k.replace('-', '_')] = v
 
288
 
 
289
        all_cmd_args = cmdargs.copy()
 
290
        all_cmd_args.update(cmdopts)
 
291
 
 
292
        return self.run(**all_cmd_args)
257
293
 
258
294
    
259
295
    def run(self):
260
 
        """Override this in sub-classes.
 
296
        """Actually run the command.
261
297
 
262
298
        This is invoked with the options and arguments bound to
263
299
        keyword parameters.
264
300
 
265
 
        Return 0 or None if the command was successful, or a shell
266
 
        error code if not.
 
301
        Return 0 or None if the command was successful, or a non-zero
 
302
        shell error code if not.  It's OK for this method to allow
 
303
        an exception to raise up.
267
304
        """
268
 
        return 0
269
 
 
270
 
 
271
 
class ExternalCommand(Command):
272
 
    """Class to wrap external commands.
273
 
 
274
 
    We cheat a little here, when get_cmd_class() calls us we actually
275
 
    give it back an object we construct that has the appropriate path,
276
 
    help, options etc for the specified command.
277
 
 
278
 
    When run_bzr() tries to instantiate that 'class' it gets caught by
279
 
    the __call__ method, which we override to call the Command.__init__
280
 
    method. That then calls our run method which is pretty straight
281
 
    forward.
282
 
 
283
 
    The only wrinkle is that we have to map bzr's dictionary of options
284
 
    and arguments back into command line options and arguments for the
285
 
    script.
286
 
    """
287
 
 
288
 
    def find_command(cls, cmd):
289
 
        import os.path
290
 
        bzrpath = os.environ.get('BZRPATH', '')
291
 
 
292
 
        for dir in bzrpath.split(os.pathsep):
293
 
            path = os.path.join(dir, cmd)
294
 
            if os.path.isfile(path):
295
 
                return ExternalCommand(path)
296
 
 
297
 
        return None
298
 
 
299
 
    find_command = classmethod(find_command)
300
 
 
301
 
    def __init__(self, path):
302
 
        self.path = path
303
 
 
304
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
305
 
        self.takes_options = pipe.readline().split()
306
 
 
307
 
        for opt in self.takes_options:
308
 
            if not opt in OPTIONS:
309
 
                raise BzrError("Unknown option '%s' returned by external command %s"
310
 
                               % (opt, path))
311
 
 
312
 
        # TODO: Is there any way to check takes_args is valid here?
313
 
        self.takes_args = pipe.readline().split()
314
 
 
315
 
        if pipe.close() is not None:
316
 
            raise BzrError("Failed funning '%s --bzr-usage'" % path)
317
 
 
318
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
319
 
        self.__doc__ = pipe.read()
320
 
        if pipe.close() is not None:
321
 
            raise BzrError("Failed funning '%s --bzr-help'" % path)
322
 
 
323
 
    def __call__(self, options, arguments):
324
 
        Command.__init__(self, options, arguments)
325
 
        return self
326
 
 
327
 
    def run(self, **kargs):
328
 
        opts = []
329
 
        args = []
330
 
 
331
 
        keys = kargs.keys()
332
 
        keys.sort()
333
 
        for name in keys:
334
 
            optname = name.replace('_','-')
335
 
            value = kargs[name]
336
 
            if OPTIONS.has_key(optname):
337
 
                # it's an option
338
 
                opts.append('--%s' % optname)
339
 
                if value is not None and value is not True:
340
 
                    opts.append(str(value))
341
 
            else:
342
 
                # it's an arg, or arg list
343
 
                if type(value) is not list:
344
 
                    value = [value]
345
 
                for v in value:
346
 
                    if v is not None:
347
 
                        args.append(str(v))
348
 
 
349
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
350
 
        return self.status
351
 
 
352
 
 
353
 
class cmd_status(Command):
354
 
    """Display status summary.
355
 
 
356
 
    This reports on versioned and unknown files, reporting them
357
 
    grouped by state.  Possible states are:
358
 
 
359
 
    added
360
 
        Versioned in the working copy but not in the previous revision.
361
 
 
362
 
    removed
363
 
        Versioned in the previous revision but removed or deleted
364
 
        in the working copy.
365
 
 
366
 
    renamed
367
 
        Path of this file changed from the previous revision;
368
 
        the text may also have changed.  This includes files whose
369
 
        parent directory was renamed.
370
 
 
371
 
    modified
372
 
        Text has changed since the previous revision.
373
 
 
374
 
    unchanged
375
 
        Nothing about this file has changed since the previous revision.
376
 
        Only shown with --all.
377
 
 
378
 
    unknown
379
 
        Not versioned and not matching an ignore pattern.
380
 
 
381
 
    To see ignored files use 'bzr ignored'.  For details in the
382
 
    changes to file texts, use 'bzr diff'.
383
 
 
384
 
    If no arguments are specified, the status of the entire working
385
 
    directory is shown.  Otherwise, only the status of the specified
386
 
    files or directories is reported.  If a directory is given, status
387
 
    is reported for everything inside that directory.
388
 
 
389
 
    If a revision is specified, the changes since that revision are shown.
390
 
    """
391
 
    takes_args = ['file*']
392
 
    takes_options = ['all', 'show-ids', 'revision']
393
 
    aliases = ['st', 'stat']
394
 
    
395
 
    def run(self, all=False, show_ids=False, file_list=None):
396
 
        if file_list:
397
 
            b = find_branch(file_list[0])
398
 
            file_list = [b.relpath(x) for x in file_list]
399
 
            # special case: only one path was given and it's the root
400
 
            # of the branch
401
 
            if file_list == ['']:
402
 
                file_list = None
403
 
        else:
404
 
            b = find_branch('.')
405
 
            
406
 
        from bzrlib.status import show_status
407
 
        show_status(b, show_unchanged=all, show_ids=show_ids,
408
 
                    specific_files=file_list)
409
 
 
410
 
 
411
 
class cmd_cat_revision(Command):
412
 
    """Write out metadata for a revision."""
413
 
 
414
 
    hidden = True
415
 
    takes_args = ['revision_id']
416
 
    
417
 
    def run(self, revision_id):
418
 
        from bzrlib.xml import pack_xml
419
 
        pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
420
 
 
421
 
 
422
 
class cmd_revno(Command):
423
 
    """Show current revision number.
424
 
 
425
 
    This is equal to the number of revisions on this branch."""
426
 
    def run(self):
427
 
        print find_branch('.').revno()
428
 
 
429
 
class cmd_revision_info(Command):
430
 
    """Show revision number and revision id for a given revision identifier.
431
 
    """
432
 
    hidden = True
433
 
    takes_args = ['revision_info*']
434
 
    takes_options = ['revision']
435
 
    def run(self, revision=None, revision_info_list=None):
436
 
        from bzrlib.branch import find_branch
437
 
 
438
 
        revs = []
439
 
        if revision is not None:
440
 
            revs.extend(revision)
441
 
        if revision_info_list is not None:
442
 
            revs.extend(revision_info_list)
443
 
        if len(revs) == 0:
444
 
            raise BzrCommandError('You must supply a revision identifier')
445
 
 
446
 
        b = find_branch('.')
447
 
 
448
 
        for rev in revs:
449
 
            print '%4d %s' % b.get_revision_info(rev)
450
 
 
451
 
    
452
 
class cmd_add(Command):
453
 
    """Add specified files or directories.
454
 
 
455
 
    In non-recursive mode, all the named items are added, regardless
456
 
    of whether they were previously ignored.  A warning is given if
457
 
    any of the named files are already versioned.
458
 
 
459
 
    In recursive mode (the default), files are treated the same way
460
 
    but the behaviour for directories is different.  Directories that
461
 
    are already versioned do not give a warning.  All directories,
462
 
    whether already versioned or not, are searched for files or
463
 
    subdirectories that are neither versioned or ignored, and these
464
 
    are added.  This search proceeds recursively into versioned
465
 
    directories.  If no names are given '.' is assumed.
466
 
 
467
 
    Therefore simply saying 'bzr add' will version all files that
468
 
    are currently unknown.
469
 
 
470
 
    TODO: Perhaps adding a file whose directly is not versioned should
471
 
    recursively add that parent, rather than giving an error?
472
 
    """
473
 
    takes_args = ['file*']
474
 
    takes_options = ['verbose', 'no-recurse']
475
 
    
476
 
    def run(self, file_list, verbose=False, no_recurse=False):
477
 
        from bzrlib.add import smart_add, _PrintAddCallback
478
 
        smart_add(file_list, verbose, not no_recurse,
479
 
                  callback=_PrintAddCallback)
480
 
 
481
 
 
482
 
 
483
 
class cmd_mkdir(Command):
484
 
    """Create a new versioned directory.
485
 
 
486
 
    This is equivalent to creating the directory and then adding it.
487
 
    """
488
 
    takes_args = ['dir+']
489
 
 
490
 
    def run(self, dir_list):
491
 
        b = None
492
 
        
493
 
        for d in dir_list:
494
 
            os.mkdir(d)
495
 
            if not b:
496
 
                b = find_branch(d)
497
 
            b.add([d], verbose=True)
498
 
 
499
 
 
500
 
class cmd_relpath(Command):
501
 
    """Show path of a file relative to root"""
502
 
    takes_args = ['filename']
503
 
    hidden = True
504
 
    
505
 
    def run(self, filename):
506
 
        print find_branch(filename).relpath(filename)
507
 
 
508
 
 
509
 
 
510
 
class cmd_inventory(Command):
511
 
    """Show inventory of the current working copy or a revision."""
512
 
    takes_options = ['revision', 'show-ids']
513
 
    
514
 
    def run(self, revision=None, show_ids=False):
515
 
        b = find_branch('.')
516
 
        if revision == None:
517
 
            inv = b.read_working_inventory()
518
 
        else:
519
 
            if len(revision) > 1:
520
 
                raise BzrCommandError('bzr inventory --revision takes'
521
 
                    ' exactly one revision identifier')
522
 
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
523
 
 
524
 
        for path, entry in inv.entries():
525
 
            if show_ids:
526
 
                print '%-50s %s' % (path, entry.file_id)
527
 
            else:
528
 
                print path
529
 
 
530
 
 
531
 
class cmd_move(Command):
532
 
    """Move files to a different directory.
533
 
 
534
 
    examples:
535
 
        bzr move *.txt doc
536
 
 
537
 
    The destination must be a versioned directory in the same branch.
538
 
    """
539
 
    takes_args = ['source$', 'dest']
540
 
    def run(self, source_list, dest):
541
 
        b = find_branch('.')
542
 
 
543
 
        # TODO: glob expansion on windows?
544
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
545
 
 
546
 
 
547
 
class cmd_rename(Command):
548
 
    """Change the name of an entry.
549
 
 
550
 
    examples:
551
 
      bzr rename frob.c frobber.c
552
 
      bzr rename src/frob.c lib/frob.c
553
 
 
554
 
    It is an error if the destination name exists.
555
 
 
556
 
    See also the 'move' command, which moves files into a different
557
 
    directory without changing their name.
558
 
 
559
 
    TODO: Some way to rename multiple files without invoking bzr for each
560
 
    one?"""
561
 
    takes_args = ['from_name', 'to_name']
562
 
    
563
 
    def run(self, from_name, to_name):
564
 
        b = find_branch('.')
565
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
566
 
 
567
 
 
568
 
 
569
 
class cmd_mv(Command):
570
 
    """Move or rename a file.
571
 
 
572
 
    usage:
573
 
        bzr mv OLDNAME NEWNAME
574
 
        bzr mv SOURCE... DESTINATION
575
 
 
576
 
    If the last argument is a versioned directory, all the other names
577
 
    are moved into it.  Otherwise, there must be exactly two arguments
578
 
    and the file is changed to a new name, which must not already exist.
579
 
 
580
 
    Files cannot be moved between branches.
581
 
    """
582
 
    takes_args = ['names*']
583
 
    def run(self, names_list):
584
 
        if len(names_list) < 2:
585
 
            raise BzrCommandError("missing file argument")
586
 
        b = find_branch(names_list[0])
587
 
 
588
 
        rel_names = [b.relpath(x) for x in names_list]
589
 
        
590
 
        if os.path.isdir(names_list[-1]):
591
 
            # move into existing directory
592
 
            b.move(rel_names[:-1], rel_names[-1])
593
 
        else:
594
 
            if len(names_list) != 2:
595
 
                raise BzrCommandError('to mv multiple files the destination '
596
 
                                      'must be a versioned directory')
597
 
            b.move(rel_names[0], rel_names[1])
598
 
            
599
 
    
600
 
 
601
 
 
602
 
class cmd_pull(Command):
603
 
    """Pull any changes from another branch into the current one.
604
 
 
605
 
    If the location is omitted, the last-used location will be used.
606
 
    Both the revision history and the working directory will be
607
 
    updated.
608
 
 
609
 
    This command only works on branches that have not diverged.  Branches are
610
 
    considered diverged if both branches have had commits without first
611
 
    pulling from the other.
612
 
 
613
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
614
 
    from one into the other.
615
 
    """
616
 
    takes_args = ['location?']
617
 
 
618
 
    def run(self, location=None):
619
 
        from bzrlib.merge import merge
620
 
        import tempfile
621
 
        from shutil import rmtree
622
 
        import errno
623
 
        from bzrlib.branch import pull_loc
624
 
        
625
 
        br_to = find_branch('.')
626
 
        stored_loc = None
627
 
        try:
628
 
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
629
 
        except IOError, e:
630
 
            if e.errno != errno.ENOENT:
631
 
                raise
632
 
        if location is None:
633
 
            if stored_loc is None:
634
 
                raise BzrCommandError("No pull location known or specified.")
635
 
            else:
636
 
                print "Using last location: %s" % stored_loc
637
 
                location = stored_loc
638
 
        cache_root = tempfile.mkdtemp()
639
 
        from bzrlib.branch import DivergedBranches
640
 
        br_from = find_branch(location)
641
 
        location = pull_loc(br_from)
642
 
        old_revno = br_to.revno()
643
 
        try:
644
 
            from branch import find_cached_branch, DivergedBranches
645
 
            br_from = find_cached_branch(location, cache_root)
646
 
            location = pull_loc(br_from)
647
 
            old_revno = br_to.revno()
648
 
            try:
649
 
                br_to.update_revisions(br_from)
650
 
            except DivergedBranches:
651
 
                raise BzrCommandError("These branches have diverged."
652
 
                    "  Try merge.")
653
 
                
654
 
            merge(('.', -1), ('.', old_revno), check_clean=False)
655
 
            if location != stored_loc:
656
 
                br_to.controlfile("x-pull", "wb").write(location + "\n")
657
 
        finally:
658
 
            rmtree(cache_root)
659
 
 
660
 
 
661
 
 
662
 
class cmd_branch(Command):
663
 
    """Create a new copy of a branch.
664
 
 
665
 
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
666
 
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
667
 
 
668
 
    To retrieve the branch as of a particular revision, supply the --revision
669
 
    parameter, as in "branch foo/bar -r 5".
670
 
    """
671
 
    takes_args = ['from_location', 'to_location?']
672
 
    takes_options = ['revision']
673
 
    aliases = ['get', 'clone']
674
 
 
675
 
    def run(self, from_location, to_location=None, revision=None):
676
 
        from bzrlib.branch import copy_branch, find_cached_branch
677
 
        import tempfile
678
 
        import errno
679
 
        from shutil import rmtree
680
 
        cache_root = tempfile.mkdtemp()
681
 
        try:
682
 
            if revision is None:
683
 
                revision = [None]
684
 
            elif len(revision) > 1:
685
 
                raise BzrCommandError(
686
 
                    'bzr branch --revision takes exactly 1 revision value')
687
 
            try:
688
 
                br_from = find_cached_branch(from_location, cache_root)
689
 
            except OSError, e:
690
 
                if e.errno == errno.ENOENT:
691
 
                    raise BzrCommandError('Source location "%s" does not'
692
 
                                          ' exist.' % to_location)
693
 
                else:
694
 
                    raise
695
 
            if to_location is None:
696
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
697
 
            try:
698
 
                os.mkdir(to_location)
699
 
            except OSError, e:
700
 
                if e.errno == errno.EEXIST:
701
 
                    raise BzrCommandError('Target directory "%s" already'
702
 
                                          ' exists.' % to_location)
703
 
                if e.errno == errno.ENOENT:
704
 
                    raise BzrCommandError('Parent of "%s" does not exist.' %
705
 
                                          to_location)
706
 
                else:
707
 
                    raise
708
 
            try:
709
 
                copy_branch(br_from, to_location, revision[0])
710
 
            except bzrlib.errors.NoSuchRevision:
711
 
                rmtree(to_location)
712
 
                msg = "The branch %s has no revision %d." % (from_location, revision[0])
713
 
                raise BzrCommandError(msg)
714
 
        finally:
715
 
            rmtree(cache_root)
716
 
 
717
 
 
718
 
class cmd_renames(Command):
719
 
    """Show list of renamed files.
720
 
 
721
 
    TODO: Option to show renames between two historical versions.
722
 
 
723
 
    TODO: Only show renames under dir, rather than in the whole branch.
724
 
    """
725
 
    takes_args = ['dir?']
726
 
 
727
 
    def run(self, dir='.'):
728
 
        b = find_branch(dir)
729
 
        old_inv = b.basis_tree().inventory
730
 
        new_inv = b.read_working_inventory()
731
 
 
732
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
733
 
        renames.sort()
734
 
        for old_name, new_name in renames:
735
 
            print "%s => %s" % (old_name, new_name)        
736
 
 
737
 
 
738
 
class cmd_info(Command):
739
 
    """Show statistical information about a branch."""
740
 
    takes_args = ['branch?']
741
 
    
742
 
    def run(self, branch=None):
743
 
        import info
744
 
 
745
 
        b = find_branch(branch)
746
 
        info.show_info(b)
747
 
 
748
 
 
749
 
class cmd_remove(Command):
750
 
    """Make a file unversioned.
751
 
 
752
 
    This makes bzr stop tracking changes to a versioned file.  It does
753
 
    not delete the working copy.
754
 
    """
755
 
    takes_args = ['file+']
756
 
    takes_options = ['verbose']
757
 
    
758
 
    def run(self, file_list, verbose=False):
759
 
        b = find_branch(file_list[0])
760
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
761
 
 
762
 
 
763
 
class cmd_file_id(Command):
764
 
    """Print file_id of a particular file or directory.
765
 
 
766
 
    The file_id is assigned when the file is first added and remains the
767
 
    same through all revisions where the file exists, even when it is
768
 
    moved or renamed.
769
 
    """
770
 
    hidden = True
771
 
    takes_args = ['filename']
772
 
    def run(self, filename):
773
 
        b = find_branch(filename)
774
 
        i = b.inventory.path2id(b.relpath(filename))
775
 
        if i == None:
776
 
            raise BzrError("%r is not a versioned file" % filename)
777
 
        else:
778
 
            print i
779
 
 
780
 
 
781
 
class cmd_file_path(Command):
782
 
    """Print path of file_ids to a file or directory.
783
 
 
784
 
    This prints one line for each directory down to the target,
785
 
    starting at the branch root."""
786
 
    hidden = True
787
 
    takes_args = ['filename']
788
 
    def run(self, filename):
789
 
        b = find_branch(filename)
790
 
        inv = b.inventory
791
 
        fid = inv.path2id(b.relpath(filename))
792
 
        if fid == None:
793
 
            raise BzrError("%r is not a versioned file" % filename)
794
 
        for fip in inv.get_idpath(fid):
795
 
            print fip
796
 
 
797
 
 
798
 
class cmd_revision_history(Command):
799
 
    """Display list of revision ids on this branch."""
800
 
    hidden = True
801
 
    def run(self):
802
 
        for patchid in find_branch('.').revision_history():
803
 
            print patchid
804
 
 
805
 
 
806
 
class cmd_directories(Command):
807
 
    """Display list of versioned directories in this branch."""
808
 
    def run(self):
809
 
        for name, ie in find_branch('.').read_working_inventory().directories():
810
 
            if name == '':
811
 
                print '.'
812
 
            else:
813
 
                print name
814
 
 
815
 
 
816
 
class cmd_init(Command):
817
 
    """Make a directory into a versioned branch.
818
 
 
819
 
    Use this to create an empty branch, or before importing an
820
 
    existing project.
821
 
 
822
 
    Recipe for importing a tree of files:
823
 
        cd ~/project
824
 
        bzr init
825
 
        bzr add -v .
826
 
        bzr status
827
 
        bzr commit -m 'imported project'
828
 
    """
829
 
    def run(self):
830
 
        from bzrlib.branch import Branch
831
 
        Branch('.', init=True)
832
 
 
833
 
 
834
 
class cmd_diff(Command):
835
 
    """Show differences in working tree.
836
 
    
837
 
    If files are listed, only the changes in those files are listed.
838
 
    Otherwise, all changes for the tree are listed.
839
 
 
840
 
    TODO: Allow diff across branches.
841
 
 
842
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
843
 
          or a graphical diff.
844
 
 
845
 
    TODO: Python difflib is not exactly the same as unidiff; should
846
 
          either fix it up or prefer to use an external diff.
847
 
 
848
 
    TODO: If a directory is given, diff everything under that.
849
 
 
850
 
    TODO: Selected-file diff is inefficient and doesn't show you
851
 
          deleted files.
852
 
 
853
 
    TODO: This probably handles non-Unix newlines poorly.
854
 
 
855
 
    examples:
856
 
        bzr diff
857
 
        bzr diff -r1
858
 
        bzr diff -r1:2
859
 
    """
860
 
    
861
 
    takes_args = ['file*']
862
 
    takes_options = ['revision', 'diff-options']
863
 
    aliases = ['di', 'dif']
864
 
 
865
 
    def run(self, revision=None, file_list=None, diff_options=None):
866
 
        from bzrlib.diff import show_diff
867
 
 
868
 
        if file_list:
869
 
            b = find_branch(file_list[0])
870
 
            file_list = [b.relpath(f) for f in file_list]
871
 
            if file_list == ['']:
872
 
                # just pointing to top-of-tree
873
 
                file_list = None
874
 
        else:
875
 
            b = find_branch('.')
876
 
 
877
 
        if revision is not None:
878
 
            if len(revision) == 1:
879
 
                show_diff(b, revision[0], specific_files=file_list,
880
 
                          external_diff_options=diff_options)
881
 
            elif len(revision) == 2:
882
 
                show_diff(b, revision[0], specific_files=file_list,
883
 
                          external_diff_options=diff_options,
884
 
                          revision2=revision[1])
885
 
            else:
886
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
887
 
        else:
888
 
            show_diff(b, None, specific_files=file_list,
889
 
                      external_diff_options=diff_options)
890
 
 
891
 
        
892
 
 
893
 
 
894
 
class cmd_deleted(Command):
895
 
    """List files deleted in the working tree.
896
 
 
897
 
    TODO: Show files deleted since a previous revision, or between two revisions.
898
 
    """
899
 
    def run(self, show_ids=False):
900
 
        b = find_branch('.')
901
 
        old = b.basis_tree()
902
 
        new = b.working_tree()
903
 
 
904
 
        ## TODO: Much more efficient way to do this: read in new
905
 
        ## directories with readdir, rather than stating each one.  Same
906
 
        ## level of effort but possibly much less IO.  (Or possibly not,
907
 
        ## if the directories are very large...)
908
 
 
909
 
        for path, ie in old.inventory.iter_entries():
910
 
            if not new.has_id(ie.file_id):
911
 
                if show_ids:
912
 
                    print '%-50s %s' % (path, ie.file_id)
913
 
                else:
914
 
                    print path
915
 
 
916
 
 
917
 
class cmd_modified(Command):
918
 
    """List files modified in working tree."""
919
 
    hidden = True
920
 
    def run(self):
921
 
        from bzrlib.delta import compare_trees
922
 
 
923
 
        b = find_branch('.')
924
 
        td = compare_trees(b.basis_tree(), b.working_tree())
925
 
 
926
 
        for path, id, kind in td.modified:
927
 
            print path
928
 
 
929
 
 
930
 
 
931
 
class cmd_added(Command):
932
 
    """List files added in working tree."""
933
 
    hidden = True
934
 
    def run(self):
935
 
        b = find_branch('.')
936
 
        wt = b.working_tree()
937
 
        basis_inv = b.basis_tree().inventory
938
 
        inv = wt.inventory
939
 
        for file_id in inv:
940
 
            if file_id in basis_inv:
941
 
                continue
942
 
            path = inv.id2path(file_id)
943
 
            if not os.access(b.abspath(path), os.F_OK):
944
 
                continue
945
 
            print path
946
 
                
947
 
        
948
 
 
949
 
class cmd_root(Command):
950
 
    """Show the tree root directory.
951
 
 
952
 
    The root is the nearest enclosing directory with a .bzr control
953
 
    directory."""
954
 
    takes_args = ['filename?']
955
 
    def run(self, filename=None):
956
 
        """Print the branch root."""
957
 
        b = find_branch(filename)
958
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
959
 
 
960
 
 
961
 
class cmd_log(Command):
962
 
    """Show log of this branch.
963
 
 
964
 
    To request a range of logs, you can use the command -r begin:end
965
 
    -r revision requests a specific revision, -r :end or -r begin: are
966
 
    also valid.
967
 
 
968
 
    --message allows you to give a regular expression, which will be evaluated
969
 
    so that only matching entries will be displayed.
970
 
 
971
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
972
 
  
973
 
    """
974
 
 
975
 
    takes_args = ['filename?']
976
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
977
 
                     'long', 'message', 'short',]
978
 
    
979
 
    def run(self, filename=None, timezone='original',
980
 
            verbose=False,
981
 
            show_ids=False,
982
 
            forward=False,
983
 
            revision=None,
984
 
            message=None,
985
 
            long=False,
986
 
            short=False):
987
 
        from bzrlib.branch import find_branch
988
 
        from bzrlib.log import log_formatter, show_log
989
 
        import codecs
990
 
 
991
 
        direction = (forward and 'forward') or 'reverse'
992
 
        
993
 
        if filename:
994
 
            b = find_branch(filename)
995
 
            fp = b.relpath(filename)
996
 
            if fp:
997
 
                file_id = b.read_working_inventory().path2id(fp)
998
 
            else:
999
 
                file_id = None  # points to branch root
1000
 
        else:
1001
 
            b = find_branch('.')
1002
 
            file_id = None
1003
 
 
1004
 
        if revision is None:
1005
 
            rev1 = None
1006
 
            rev2 = None
1007
 
        elif len(revision) == 1:
1008
 
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
1009
 
        elif len(revision) == 2:
1010
 
            rev1 = b.get_revision_info(revision[0])[0]
1011
 
            rev2 = b.get_revision_info(revision[1])[0]
1012
 
        else:
1013
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
1014
 
 
1015
 
        if rev1 == 0:
1016
 
            rev1 = None
1017
 
        if rev2 == 0:
1018
 
            rev2 = None
1019
 
 
1020
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
1021
 
 
1022
 
        # use 'replace' so that we don't abort if trying to write out
1023
 
        # in e.g. the default C locale.
1024
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1025
 
 
1026
 
        if not short:
1027
 
            log_format = 'long'
1028
 
        else:
1029
 
            log_format = 'short'
1030
 
        lf = log_formatter(log_format,
1031
 
                           show_ids=show_ids,
1032
 
                           to_file=outf,
1033
 
                           show_timezone=timezone)
1034
 
 
1035
 
        show_log(b,
1036
 
                 lf,
1037
 
                 file_id,
1038
 
                 verbose=verbose,
1039
 
                 direction=direction,
1040
 
                 start_revision=rev1,
1041
 
                 end_revision=rev2,
1042
 
                 search=message)
1043
 
 
1044
 
 
1045
 
 
1046
 
class cmd_touching_revisions(Command):
1047
 
    """Return revision-ids which affected a particular file.
1048
 
 
1049
 
    A more user-friendly interface is "bzr log FILE"."""
1050
 
    hidden = True
1051
 
    takes_args = ["filename"]
1052
 
    def run(self, filename):
1053
 
        b = find_branch(filename)
1054
 
        inv = b.read_working_inventory()
1055
 
        file_id = inv.path2id(b.relpath(filename))
1056
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1057
 
            print "%6d %s" % (revno, what)
1058
 
 
1059
 
 
1060
 
class cmd_ls(Command):
1061
 
    """List files in a tree.
1062
 
 
1063
 
    TODO: Take a revision or remote path and list that tree instead.
1064
 
    """
1065
 
    hidden = True
1066
 
    def run(self, revision=None, verbose=False):
1067
 
        b = find_branch('.')
1068
 
        if revision == None:
1069
 
            tree = b.working_tree()
1070
 
        else:
1071
 
            tree = b.revision_tree(b.lookup_revision(revision))
1072
 
 
1073
 
        for fp, fc, kind, fid in tree.list_files():
1074
 
            if verbose:
1075
 
                if kind == 'directory':
1076
 
                    kindch = '/'
1077
 
                elif kind == 'file':
1078
 
                    kindch = ''
1079
 
                else:
1080
 
                    kindch = '???'
1081
 
 
1082
 
                print '%-8s %s%s' % (fc, fp, kindch)
1083
 
            else:
1084
 
                print fp
1085
 
 
1086
 
 
1087
 
 
1088
 
class cmd_unknowns(Command):
1089
 
    """List unknown files."""
1090
 
    def run(self):
1091
 
        from bzrlib.osutils import quotefn
1092
 
        for f in find_branch('.').unknowns():
1093
 
            print quotefn(f)
1094
 
 
1095
 
 
1096
 
 
1097
 
class cmd_ignore(Command):
1098
 
    """Ignore a command or pattern.
1099
 
 
1100
 
    To remove patterns from the ignore list, edit the .bzrignore file.
1101
 
 
1102
 
    If the pattern contains a slash, it is compared to the whole path
1103
 
    from the branch root.  Otherwise, it is comapred to only the last
1104
 
    component of the path.
1105
 
 
1106
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1107
 
 
1108
 
    Note: wildcards must be quoted from the shell on Unix.
1109
 
 
1110
 
    examples:
1111
 
        bzr ignore ./Makefile
1112
 
        bzr ignore '*.class'
1113
 
    """
1114
 
    takes_args = ['name_pattern']
1115
 
    
1116
 
    def run(self, name_pattern):
1117
 
        from bzrlib.atomicfile import AtomicFile
1118
 
        import os.path
1119
 
 
1120
 
        b = find_branch('.')
1121
 
        ifn = b.abspath('.bzrignore')
1122
 
 
1123
 
        if os.path.exists(ifn):
1124
 
            f = open(ifn, 'rt')
1125
 
            try:
1126
 
                igns = f.read().decode('utf-8')
1127
 
            finally:
1128
 
                f.close()
1129
 
        else:
1130
 
            igns = ''
1131
 
 
1132
 
        # TODO: If the file already uses crlf-style termination, maybe
1133
 
        # we should use that for the newly added lines?
1134
 
 
1135
 
        if igns and igns[-1] != '\n':
1136
 
            igns += '\n'
1137
 
        igns += name_pattern + '\n'
1138
 
 
1139
 
        try:
1140
 
            f = AtomicFile(ifn, 'wt')
1141
 
            f.write(igns.encode('utf-8'))
1142
 
            f.commit()
1143
 
        finally:
1144
 
            f.close()
1145
 
 
1146
 
        inv = b.working_tree().inventory
1147
 
        if inv.path2id('.bzrignore'):
1148
 
            mutter('.bzrignore is already versioned')
1149
 
        else:
1150
 
            mutter('need to make new .bzrignore file versioned')
1151
 
            b.add(['.bzrignore'])
1152
 
 
1153
 
 
1154
 
 
1155
 
class cmd_ignored(Command):
1156
 
    """List ignored files and the patterns that matched them.
1157
 
 
1158
 
    See also: bzr ignore"""
1159
 
    def run(self):
1160
 
        tree = find_branch('.').working_tree()
1161
 
        for path, file_class, kind, file_id in tree.list_files():
1162
 
            if file_class != 'I':
1163
 
                continue
1164
 
            ## XXX: Slightly inefficient since this was already calculated
1165
 
            pat = tree.is_ignored(path)
1166
 
            print '%-50s %s' % (path, pat)
1167
 
 
1168
 
 
1169
 
class cmd_lookup_revision(Command):
1170
 
    """Lookup the revision-id from a revision-number
1171
 
 
1172
 
    example:
1173
 
        bzr lookup-revision 33
1174
 
    """
1175
 
    hidden = True
1176
 
    takes_args = ['revno']
1177
 
    
1178
 
    def run(self, revno):
1179
 
        try:
1180
 
            revno = int(revno)
1181
 
        except ValueError:
1182
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
1183
 
 
1184
 
        print find_branch('.').lookup_revision(revno)
1185
 
 
1186
 
 
1187
 
class cmd_export(Command):
1188
 
    """Export past revision to destination directory.
1189
 
 
1190
 
    If no revision is specified this exports the last committed revision.
1191
 
 
1192
 
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1193
 
    given, try to find the format with the extension. If no extension
1194
 
    is found exports to a directory (equivalent to --format=dir).
1195
 
 
1196
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1197
 
    is given, the top directory will be the root name of the file."""
1198
 
    # TODO: list known exporters
1199
 
    takes_args = ['dest']
1200
 
    takes_options = ['revision', 'format', 'root']
1201
 
    def run(self, dest, revision=None, format=None, root=None):
1202
 
        import os.path
1203
 
        b = find_branch('.')
1204
 
        if revision is None:
1205
 
            rev_id = b.last_patch()
1206
 
        else:
1207
 
            if len(revision) != 1:
1208
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1209
 
            revno, rev_id = b.get_revision_info(revision[0])
1210
 
        t = b.revision_tree(rev_id)
1211
 
        root, ext = os.path.splitext(dest)
1212
 
        if not format:
1213
 
            if ext in (".tar",):
1214
 
                format = "tar"
1215
 
            elif ext in (".gz", ".tgz"):
1216
 
                format = "tgz"
1217
 
            elif ext in (".bz2", ".tbz2"):
1218
 
                format = "tbz2"
1219
 
            else:
1220
 
                format = "dir"
1221
 
        t.export(dest, format, root)
1222
 
 
1223
 
 
1224
 
class cmd_cat(Command):
1225
 
    """Write a file's text from a previous revision."""
1226
 
 
1227
 
    takes_options = ['revision']
1228
 
    takes_args = ['filename']
1229
 
 
1230
 
    def run(self, filename, revision=None):
1231
 
        if revision == None:
1232
 
            raise BzrCommandError("bzr cat requires a revision number")
1233
 
        elif len(revision) != 1:
1234
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1235
 
        b = find_branch('.')
1236
 
        b.print_file(b.relpath(filename), revision[0])
1237
 
 
1238
 
 
1239
 
class cmd_local_time_offset(Command):
1240
 
    """Show the offset in seconds from GMT to local time."""
1241
 
    hidden = True    
1242
 
    def run(self):
1243
 
        print bzrlib.osutils.local_time_offset()
1244
 
 
1245
 
 
1246
 
 
1247
 
class cmd_commit(Command):
1248
 
    """Commit changes into a new revision.
1249
 
    
1250
 
    If no arguments are given, the entire tree is committed.
1251
 
 
1252
 
    If selected files are specified, only changes to those files are
1253
 
    committed.  If a directory is specified then the directory and everything 
1254
 
    within it is committed.
1255
 
 
1256
 
    A selected-file commit may fail in some cases where the committed
1257
 
    tree would be invalid, such as trying to commit a file in a
1258
 
    newly-added directory that is not itself committed.
1259
 
 
1260
 
    TODO: Run hooks on tree to-be-committed, and after commit.
1261
 
 
1262
 
    TODO: Strict commit that fails if there are unknown or deleted files.
1263
 
    """
1264
 
    takes_args = ['selected*']
1265
 
    takes_options = ['message', 'file', 'verbose', 'unchanged']
1266
 
    aliases = ['ci', 'checkin']
1267
 
 
1268
 
    # TODO: Give better message for -s, --summary, used by tla people
1269
 
    
1270
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1271
 
            unchanged=False):
1272
 
        from bzrlib.errors import PointlessCommit
1273
 
        from bzrlib.osutils import get_text_message
1274
 
 
1275
 
        ## Warning: shadows builtin file()
1276
 
        if not message and not file:
1277
 
            # FIXME: Ugly; change status code to send to a provided function?
1278
 
            
1279
 
            import cStringIO
1280
 
            stdout = sys.stdout
1281
 
            catcher = cStringIO.StringIO()
1282
 
            sys.stdout = catcher
1283
 
            cmd_status({"file_list":selected_list}, {})
1284
 
            info = catcher.getvalue()
1285
 
            sys.stdout = stdout
1286
 
            message = get_text_message(info)
1287
 
            
1288
 
            if message is None:
1289
 
                raise BzrCommandError("please specify a commit message",
1290
 
                                      ["use either --message or --file"])
1291
 
        elif message and file:
1292
 
            raise BzrCommandError("please specify either --message or --file")
1293
 
        
1294
 
        if file:
1295
 
            import codecs
1296
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1297
 
 
1298
 
        b = find_branch('.')
1299
 
        if selected_list:
1300
 
            selected_list = [b.relpath(s) for s in selected_list]
1301
 
            
1302
 
        try:
1303
 
            b.commit(message, verbose=verbose,
1304
 
                     specific_files=selected_list,
1305
 
                     allow_pointless=unchanged)
1306
 
        except PointlessCommit:
1307
 
            # FIXME: This should really happen before the file is read in;
1308
 
            # perhaps prepare the commit; get the message; then actually commit
1309
 
            raise BzrCommandError("no changes to commit",
1310
 
                                  ["use --unchanged to commit anyhow"])
1311
 
 
1312
 
 
1313
 
class cmd_check(Command):
1314
 
    """Validate consistency of branch history.
1315
 
 
1316
 
    This command checks various invariants about the branch storage to
1317
 
    detect data corruption or bzr bugs.
1318
 
 
1319
 
    If given the --update flag, it will update some optional fields
1320
 
    to help ensure data consistency.
1321
 
    """
1322
 
    takes_args = ['dir?']
1323
 
 
1324
 
    def run(self, dir='.'):
1325
 
        from bzrlib.check import check
1326
 
 
1327
 
        check(find_branch(dir))
1328
 
 
1329
 
 
1330
 
class cmd_scan_cache(Command):
1331
 
    hidden = True
1332
 
    def run(self):
1333
 
        from bzrlib.hashcache import HashCache
1334
 
        import os
1335
 
 
1336
 
        c = HashCache('.')
1337
 
        c.read()
1338
 
        c.scan()
1339
 
            
1340
 
        print '%6d stats' % c.stat_count
1341
 
        print '%6d in hashcache' % len(c._cache)
1342
 
        print '%6d files removed from cache' % c.removed_count
1343
 
        print '%6d hashes updated' % c.update_count
1344
 
        print '%6d files changed too recently to cache' % c.danger_count
1345
 
 
1346
 
        if c.needs_write:
1347
 
            c.write()
1348
 
            
1349
 
 
1350
 
 
1351
 
class cmd_upgrade(Command):
1352
 
    """Upgrade branch storage to current format.
1353
 
 
1354
 
    This should normally be used only after the check command tells
1355
 
    you to run it.
1356
 
    """
1357
 
    takes_args = ['dir?']
1358
 
 
1359
 
    def run(self, dir='.'):
1360
 
        from bzrlib.upgrade import upgrade
1361
 
        upgrade(find_branch(dir))
1362
 
 
1363
 
 
1364
 
 
1365
 
class cmd_whoami(Command):
1366
 
    """Show bzr user id."""
1367
 
    takes_options = ['email']
1368
 
    
1369
 
    def run(self, email=False):
1370
 
        try:
1371
 
            b = bzrlib.branch.find_branch('.')
1372
 
        except:
1373
 
            b = None
1374
 
        
1375
 
        if email:
1376
 
            print bzrlib.osutils.user_email(b)
1377
 
        else:
1378
 
            print bzrlib.osutils.username(b)
1379
 
 
1380
 
 
1381
 
class cmd_selftest(Command):
1382
 
    """Run internal test suite"""
1383
 
    hidden = True
1384
 
    takes_options = ['verbose', 'pattern']
1385
 
    def run(self, verbose=False, pattern=".*"):
1386
 
        import bzrlib.ui
1387
 
        from bzrlib.selftest import selftest
1388
 
        # we don't want progress meters from the tests to go to the
1389
 
        # real output; and we don't want log messages cluttering up
1390
 
        # the real logs.
1391
 
        save_ui = bzrlib.ui.ui_factory
1392
 
        bzrlib.trace.info('running tests...')
1393
 
        bzrlib.trace.disable_default_logging()
1394
 
        try:
1395
 
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1396
 
            result = selftest(verbose=verbose, pattern=pattern)
1397
 
            if result:
1398
 
                bzrlib.trace.info('tests passed')
1399
 
            else:
1400
 
                bzrlib.trace.info('tests failed')
1401
 
            return int(not result)
1402
 
        finally:
1403
 
            bzrlib.trace.enable_default_logging()
1404
 
            bzrlib.ui.ui_factory = save_ui
1405
 
 
1406
 
 
1407
 
class cmd_version(Command):
1408
 
    """Show version of bzr."""
1409
 
    def run(self):
1410
 
        show_version()
1411
 
 
1412
 
def show_version():
1413
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1414
 
    # is bzrlib itself in a branch?
1415
 
    bzrrev = bzrlib.get_bzr_revision()
1416
 
    if bzrrev:
1417
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1418
 
    print bzrlib.__copyright__
1419
 
    print "http://bazaar-ng.org/"
1420
 
    print
1421
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1422
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1423
 
    print "General Public License version 2 or later."
1424
 
 
1425
 
 
1426
 
class cmd_rocks(Command):
1427
 
    """Statement of optimism."""
1428
 
    hidden = True
1429
 
    def run(self):
1430
 
        print "it sure does!"
 
305
        raise NotImplementedError()
 
306
 
 
307
 
 
308
    def help(self):
 
309
        """Return help message for this class."""
 
310
        if self.__doc__ is Command.__doc__:
 
311
            return None
 
312
        return getdoc(self)
 
313
 
 
314
    def name(self):
 
315
        return _unsquish_command_name(self.__class__.__name__)
 
316
 
1431
317
 
1432
318
def parse_spec(spec):
1433
319
    """
1461
347
    return parsed
1462
348
 
1463
349
 
1464
 
 
1465
 
class cmd_find_merge_base(Command):
1466
 
    """Find and print a base revision for merging two branches.
1467
 
 
1468
 
    TODO: Options to specify revisions on either side, as if
1469
 
          merging only part of the history.
1470
 
    """
1471
 
    takes_args = ['branch', 'other']
1472
 
    hidden = True
1473
 
    
1474
 
    def run(self, branch, other):
1475
 
        branch1 = find_branch(branch)
1476
 
        branch2 = find_branch(other)
1477
 
 
1478
 
        base_revno, base_revid = branch1.common_ancestor(branch2)
1479
 
 
1480
 
        if base_revno is None:
1481
 
            raise bzrlib.errors.UnrelatedBranches()
1482
 
 
1483
 
        print 'merge base is revision %s' % base_revid
1484
 
        print ' r%-6d in %s' % (base_revno, branch)
1485
 
 
1486
 
        other_revno = branch2.revision_id_to_revno(base_revid)
1487
 
        
1488
 
        print ' r%-6d in %s' % (other_revno, other)
1489
 
 
1490
 
 
1491
 
 
1492
 
class cmd_merge(Command):
1493
 
    """Perform a three-way merge.
1494
 
    
1495
 
    The branch is the branch you will merge from.  By default, it will merge
1496
 
    the latest revision.  If you specify a revision, that revision will be
1497
 
    merged.  If you specify two revisions, the first will be used as a BASE, 
1498
 
    and the second one as OTHER.  Revision numbers are always relative to the
1499
 
    specified branch.
1500
 
    
1501
 
    Examples:
1502
 
 
1503
 
    To merge the latest revision from bzr.dev
1504
 
    bzr merge ../bzr.dev
1505
 
 
1506
 
    To merge changes up to and including revision 82 from bzr.dev
1507
 
    bzr merge -r 82 ../bzr.dev
1508
 
 
1509
 
    To merge the changes introduced by 82, without previous changes:
1510
 
    bzr merge -r 81..82 ../bzr.dev
1511
 
    
1512
 
    merge refuses to run if there are any uncommitted changes, unless
1513
 
    --force is given.
1514
 
    """
1515
 
    takes_args = ['branch?']
1516
 
    takes_options = ['revision', 'force', 'merge-type']
1517
 
 
1518
 
    def run(self, branch='.', revision=None, force=False, 
1519
 
            merge_type=None):
1520
 
        from bzrlib.merge import merge
1521
 
        from bzrlib.merge_core import ApplyMerge3
1522
 
        if merge_type is None:
1523
 
            merge_type = ApplyMerge3
1524
 
 
1525
 
        if revision is None or len(revision) < 1:
1526
 
            base = [None, None]
1527
 
            other = [branch, -1]
1528
 
        else:
1529
 
            if len(revision) == 1:
1530
 
                other = [branch, revision[0]]
1531
 
                base = [None, None]
1532
 
            else:
1533
 
                assert len(revision) == 2
1534
 
                if None in revision:
1535
 
                    raise BzrCommandError(
1536
 
                        "Merge doesn't permit that revision specifier.")
1537
 
                base = (branch, revision[0])
1538
 
                other = (branch, revision[1])
1539
 
            
1540
 
        merge(other, base, check_clean=(not force), merge_type=merge_type)
1541
 
 
1542
 
 
1543
 
class cmd_revert(Command):
1544
 
    """Reverse all changes since the last commit.
1545
 
 
1546
 
    Only versioned files are affected.  Specify filenames to revert only 
1547
 
    those files.  By default, any files that are changed will be backed up
1548
 
    first.  Backup files have a '~' appended to their name.
1549
 
    """
1550
 
    takes_options = ['revision', 'no-backup']
1551
 
    takes_args = ['file*']
1552
 
    aliases = ['merge-revert']
1553
 
 
1554
 
    def run(self, revision=None, no_backup=False, file_list=None):
1555
 
        from bzrlib.merge import merge
1556
 
        from bzrlib.branch import Branch
1557
 
        if file_list is not None:
1558
 
            if len(file_list) == 0:
1559
 
                raise BzrCommandError("No files specified")
1560
 
        if revision is None:
1561
 
            revision = [-1]
1562
 
        elif len(revision) != 1:
1563
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1564
 
        merge(('.', revision[0]), parse_spec('.'),
1565
 
              check_clean=False,
1566
 
              ignore_zero=True,
1567
 
              backup_files=not no_backup,
1568
 
              file_list=file_list)
1569
 
        if not file_list:
1570
 
            Branch('.').set_pending_merges([])
1571
 
 
1572
 
 
1573
 
class cmd_assert_fail(Command):
1574
 
    """Test reporting of assertion failures"""
1575
 
    hidden = True
1576
 
    def run(self):
1577
 
        assert False, "always fails"
1578
 
 
1579
 
 
1580
 
class cmd_help(Command):
1581
 
    """Show help on a command or other topic.
1582
 
 
1583
 
    For a list of all available commands, say 'bzr help commands'."""
1584
 
    takes_options = ['long']
1585
 
    takes_args = ['topic?']
1586
 
    aliases = ['?']
1587
 
    
1588
 
    def run(self, topic=None, long=False):
1589
 
        import help
1590
 
        if topic is None and long:
1591
 
            topic = "commands"
1592
 
        help.help(topic)
1593
 
 
1594
 
 
1595
 
class cmd_shell_complete(Command):
1596
 
    """Show appropriate completions for context.
1597
 
 
1598
 
    For a list of all available commands, say 'bzr shell-complete'."""
1599
 
    takes_args = ['context?']
1600
 
    aliases = ['s-c']
1601
 
    hidden = True
1602
 
    
1603
 
    def run(self, context=None):
1604
 
        import shellcomplete
1605
 
        shellcomplete.shellcomplete(context)
1606
 
 
1607
 
 
1608
 
class cmd_missing(Command):
1609
 
    """What is missing in this branch relative to other branch.
1610
 
    """
1611
 
    takes_args = ['remote?']
1612
 
    aliases = ['mis', 'miss']
1613
 
    # We don't have to add quiet to the list, because 
1614
 
    # unknown options are parsed as booleans
1615
 
    takes_options = ['verbose', 'quiet']
1616
 
 
1617
 
    def run(self, remote=None, verbose=False, quiet=False):
1618
 
        from bzrlib.branch import find_branch, DivergedBranches
1619
 
        from bzrlib.errors import BzrCommandError
1620
 
        from bzrlib.missing import get_parent, show_missing
1621
 
 
1622
 
        if verbose and quiet:
1623
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1624
 
 
1625
 
        b = find_branch('.')
1626
 
        parent = get_parent(b)
1627
 
        if remote is None:
1628
 
            if parent is None:
1629
 
                raise BzrCommandError("No missing location known or specified.")
1630
 
            else:
1631
 
                if not quiet:
1632
 
                    print "Using last location: %s" % parent
1633
 
                remote = parent
1634
 
        elif parent is None:
1635
 
            # We only update x-pull if it did not exist, missing should not change the parent
1636
 
            b.controlfile('x-pull', 'wb').write(remote + '\n')
1637
 
        br_remote = find_branch(remote)
1638
 
 
1639
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1640
 
 
1641
 
 
1642
 
 
1643
 
class cmd_plugins(Command):
1644
 
    """List plugins"""
1645
 
    hidden = True
1646
 
    def run(self):
1647
 
        import bzrlib.plugin
1648
 
        from inspect import getdoc
1649
 
        from pprint import pprint
1650
 
        for plugin in bzrlib.plugin.all_plugins:
1651
 
            print plugin.__path__[0]
1652
 
            d = getdoc(plugin)
1653
 
            if d:
1654
 
                print '\t', d.split('\n')[0]
1655
 
 
1656
 
        #pprint(bzrlib.plugin.all_plugins)
1657
 
 
1658
 
 
1659
 
 
1660
350
# list of all available options; the rhs can be either None for an
1661
351
# option that takes no argument, or a constructor function that checks
1662
352
# the type.
1707
397
 
1708
398
    >>> parse_args('--help'.split())
1709
399
    ([], {'help': True})
 
400
    >>> parse_args('help -- --invalidcmd'.split())
 
401
    (['help', '--invalidcmd'], {})
1710
402
    >>> parse_args('--version'.split())
1711
403
    ([], {'version': True})
1712
404
    >>> parse_args('status --all'.split())
1714
406
    >>> parse_args('commit --message=biter'.split())
1715
407
    (['commit'], {'message': u'biter'})
1716
408
    >>> parse_args('log -r 500'.split())
1717
 
    (['log'], {'revision': [500]})
 
409
    (['log'], {'revision': [<RevisionSpec_int 500>]})
1718
410
    >>> parse_args('log -r500..600'.split())
1719
 
    (['log'], {'revision': [500, 600]})
 
411
    (['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
1720
412
    >>> parse_args('log -vr500..600'.split())
1721
 
    (['log'], {'verbose': True, 'revision': [500, 600]})
1722
 
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
1723
 
    (['log'], {'revision': ['v500', 600]})
 
413
    (['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
 
414
    >>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
 
415
    (['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
1724
416
    """
1725
417
    args = []
1726
418
    opts = {}
1727
419
 
1728
 
    # TODO: Maybe handle '--' to end options?
1729
 
 
 
420
    argsover = False
1730
421
    while argv:
1731
422
        a = argv.pop(0)
1732
 
        if a[0] == '-':
 
423
        if not argsover and a[0] == '-':
1733
424
            # option names must not be unicode
1734
425
            a = str(a)
1735
426
            optarg = None
1736
427
            if a[1] == '-':
 
428
                if a == '--':
 
429
                    # We've received a standalone -- No more flags
 
430
                    argsover = True
 
431
                    continue
1737
432
                mutter("  got option %r" % a)
1738
433
                if '=' in a:
1739
434
                    optname, optarg = a[2:].split('=', 1)
1841
536
 
1842
537
 
1843
538
 
 
539
def apply_profiled(the_callable, *args, **kwargs):
 
540
    import hotshot
 
541
    import tempfile
 
542
    pffileno, pfname = tempfile.mkstemp()
 
543
    try:
 
544
        prof = hotshot.Profile(pfname)
 
545
        try:
 
546
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
547
        finally:
 
548
            prof.close()
 
549
 
 
550
        import hotshot.stats
 
551
        stats = hotshot.stats.load(pfname)
 
552
        #stats.strip_dirs()
 
553
        stats.sort_stats('time')
 
554
        ## XXX: Might like to write to stderr or the trace file instead but
 
555
        ## print_stats seems hardcoded to stdout
 
556
        stats.print_stats(20)
 
557
 
 
558
        return ret
 
559
    finally:
 
560
        os.close(pffileno)
 
561
        os.remove(pfname)
 
562
 
 
563
 
1844
564
def run_bzr(argv):
1845
565
    """Execute a command.
1846
566
 
1874
594
    # to load plugins before doing other command parsing so that they
1875
595
    # can override commands, but this needs to happen first.
1876
596
 
1877
 
    for a in argv[:]:
 
597
    for a in argv:
1878
598
        if a == '--profile':
1879
599
            opt_profile = True
1880
600
        elif a == '--no-plugins':
1885
605
            break
1886
606
        argv.remove(a)
1887
607
 
 
608
    if (not argv) or (argv[0] == '--help'):
 
609
        from bzrlib.help import help
 
610
        if len(argv) > 1:
 
611
            help(argv[1])
 
612
        else:
 
613
            help()
 
614
        return 0
 
615
 
 
616
    if argv[0] == '--version':
 
617
        from bzrlib.builtins import show_version
 
618
        show_version()
 
619
        return 0
 
620
        
1888
621
    if not opt_no_plugins:
1889
622
        from bzrlib.plugin import load_plugins
1890
623
        load_plugins()
1891
624
 
1892
 
    args, opts = parse_args(argv)
1893
 
 
1894
 
    if 'help' in opts:
1895
 
        from bzrlib.help import help
1896
 
        if args:
1897
 
            help(args[0])
1898
 
        else:
1899
 
            help()
1900
 
        return 0            
1901
 
        
1902
 
    if 'version' in opts:
1903
 
        show_version()
1904
 
        return 0
1905
 
    
1906
 
    if not args:
1907
 
        from bzrlib.help import help
1908
 
        help(None)
1909
 
        return 0
1910
 
    
1911
 
    cmd = str(args.pop(0))
1912
 
 
1913
 
    canonical_cmd, cmd_class = \
1914
 
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
1915
 
 
1916
 
    # check options are reasonable
1917
 
    allowed = cmd_class.takes_options
1918
 
    for oname in opts:
1919
 
        if oname not in allowed:
1920
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1921
 
                                  % (oname, cmd))
1922
 
 
1923
 
    # mix arguments and options into one dictionary
1924
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1925
 
    cmdopts = {}
1926
 
    for k, v in opts.items():
1927
 
        cmdopts[k.replace('-', '_')] = v
 
625
    cmd = str(argv.pop(0))
 
626
 
 
627
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1928
628
 
1929
629
    if opt_profile:
1930
 
        import hotshot, tempfile
1931
 
        pffileno, pfname = tempfile.mkstemp()
1932
 
        try:
1933
 
            prof = hotshot.Profile(pfname)
1934
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1935
 
            prof.close()
1936
 
 
1937
 
            import hotshot.stats
1938
 
            stats = hotshot.stats.load(pfname)
1939
 
            #stats.strip_dirs()
1940
 
            stats.sort_stats('time')
1941
 
            ## XXX: Might like to write to stderr or the trace file instead but
1942
 
            ## print_stats seems hardcoded to stdout
1943
 
            stats.print_stats(20)
1944
 
            
1945
 
            return ret.status
1946
 
 
1947
 
        finally:
1948
 
            os.close(pffileno)
1949
 
            os.remove(pfname)
 
630
        ret = apply_profiled(cmd_obj.run_argv, argv)
1950
631
    else:
1951
 
        return cmd_class(cmdopts, cmdargs).status 
 
632
        ret = cmd_obj.run_argv(argv)
 
633
    return ret or 0
1952
634
 
1953
635
 
1954
636
def main(argv):
1956
638
    bzrlib.trace.log_startup(argv)
1957
639
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1958
640
 
 
641
    return run_bzr_catch_errors(argv[1:])
 
642
 
 
643
 
 
644
def run_bzr_catch_errors(argv):
1959
645
    try:
1960
646
        try:
1961
 
            return run_bzr(argv[1:])
1962
 
        finally:
1963
 
            # do this here inside the exception wrappers to catch EPIPE
1964
 
            sys.stdout.flush()
 
647
            try:
 
648
                return run_bzr(argv)
 
649
            finally:
 
650
                # do this here inside the exception wrappers to catch EPIPE
 
651
                sys.stdout.flush()
 
652
        #wrap common errors as CommandErrors.
 
653
        except (NotBranchError,), e:
 
654
            raise BzrCommandError(str(e))
1965
655
    except BzrCommandError, e:
1966
656
        # command line syntax error, etc
1967
657
        log_error(str(e))