~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Robert Collins
  • Date: 2005-08-25 10:04:51 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825100451-b01297285491ba46
make a default merge choose a sane base with branch.common_ancestor

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