/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-22 23:43:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050722234326-13104af9d837ed2b
todo

Show diffs side-by-side

added added

removed removed

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