~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

- merge improved merge base selection from aaron
aaron.bentley@utoronto.ca-20050912025534-43d7275dd948e4ad

Show diffs side-by-side

added added

removed removed

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