← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-08-26 02:31:37 UTC
  • Revision ID: mbp@sourcefrog.net-20050826023137-eb4b101cc92f9792
- ignore tags files

Show diffs side-by-side

added added

removed removed

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