/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-11 23:13:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050711231333-4e73c6333b8d8213
- merge aaron's merge-rename fix

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