/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: aaron.bentley at utoronto
  • Date: 2005-07-15 01:57:33 UTC
  • mto: This revision was merged to the branch mainline in revision 923.
  • Revision ID: aaron.bentley@utoronto.ca-20050715015733-c336ac2a6ed91692
Fixed rename handling in merge

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
        try:
 
595
            try:
 
596
                br_from = find_cached_branch(from_location, cache_root)
 
597
            except OSError, e:
 
598
                if e.errno == errno.ENOENT:
 
599
                    raise BzrCommandError('Source location "%s" does not'
 
600
                                          ' exist.' % to_location)
 
601
                else:
 
602
                    raise
 
603
 
 
604
            if to_location is None:
 
605
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
606
 
 
607
            try:
 
608
                os.mkdir(to_location)
 
609
            except OSError, e:
 
610
                if e.errno == errno.EEXIST:
 
611
                    raise BzrCommandError('Target directory "%s" already'
 
612
                                          ' exists.' % to_location)
 
613
                if e.errno == errno.ENOENT:
 
614
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
615
                                          to_location)
 
616
                else:
 
617
                    raise
 
618
            br_to = Branch(to_location, init=True)
 
619
 
 
620
            br_to.set_root_id(br_from.get_root_id())
 
621
 
 
622
            if revision:
 
623
                revno = br_to.lookup_revision(revision[0])
 
624
                try:
 
625
                    br_to.update_revisions(br_from, stop_revision=revno)
 
626
                except NoSuchRevision:
 
627
                    rmtree(to_location)
 
628
                    msg = "The branch %s has no revision %d." % (from_location,
 
629
                                                                 revno)
 
630
                    raise BzrCommandError(msg)
 
631
            
 
632
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
633
                  check_clean=False, ignore_zero=True)
 
634
            from_location = pull_loc(br_from)
 
635
            br_to.controlfile("x-pull", "wb").write(from_location + "\n")
 
636
        finally:
 
637
            rmtree(cache_root)
 
638
 
 
639
 
 
640
def pull_loc(branch):
 
641
    # TODO: Should perhaps just make attribute be 'base' in
 
642
    # RemoteBranch and Branch?
 
643
    if hasattr(branch, "baseurl"):
 
644
        return branch.baseurl
 
645
    else:
 
646
        return branch.base
 
647
 
 
648
 
 
649
 
 
650
class cmd_renames(Command):
 
651
    """Show list of renamed files.
 
652
 
 
653
    TODO: Option to show renames between two historical versions.
 
654
 
 
655
    TODO: Only show renames under dir, rather than in the whole branch.
 
656
    """
 
657
    takes_args = ['dir?']
 
658
 
 
659
    def run(self, dir='.'):
 
660
        b = find_branch(dir)
 
661
        old_inv = b.basis_tree().inventory
 
662
        new_inv = b.read_working_inventory()
 
663
 
 
664
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
665
        renames.sort()
 
666
        for old_name, new_name in renames:
 
667
            print "%s => %s" % (old_name, new_name)        
 
668
 
 
669
 
 
670
class cmd_info(Command):
 
671
    """Show statistical information about a branch."""
 
672
    takes_args = ['branch?']
 
673
    
 
674
    def run(self, branch=None):
 
675
        import info
 
676
 
 
677
        b = find_branch(branch)
 
678
        info.show_info(b)
 
679
 
 
680
 
 
681
class cmd_remove(Command):
 
682
    """Make a file unversioned.
 
683
 
 
684
    This makes bzr stop tracking changes to a versioned file.  It does
 
685
    not delete the working copy.
 
686
    """
 
687
    takes_args = ['file+']
 
688
    takes_options = ['verbose']
 
689
    
 
690
    def run(self, file_list, verbose=False):
 
691
        b = find_branch(file_list[0])
 
692
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
693
 
 
694
 
 
695
class cmd_file_id(Command):
 
696
    """Print file_id of a particular file or directory.
 
697
 
 
698
    The file_id is assigned when the file is first added and remains the
 
699
    same through all revisions where the file exists, even when it is
 
700
    moved or renamed.
 
701
    """
 
702
    hidden = True
 
703
    takes_args = ['filename']
 
704
    def run(self, filename):
 
705
        b = find_branch(filename)
 
706
        i = b.inventory.path2id(b.relpath(filename))
 
707
        if i == None:
 
708
            raise BzrError("%r is not a versioned file" % filename)
 
709
        else:
 
710
            print i
 
711
 
 
712
 
 
713
class cmd_file_path(Command):
 
714
    """Print path of file_ids to a file or directory.
 
715
 
 
716
    This prints one line for each directory down to the target,
 
717
    starting at the branch root."""
 
718
    hidden = True
 
719
    takes_args = ['filename']
 
720
    def run(self, filename):
 
721
        b = find_branch(filename)
 
722
        inv = b.inventory
 
723
        fid = inv.path2id(b.relpath(filename))
 
724
        if fid == None:
 
725
            raise BzrError("%r is not a versioned file" % filename)
 
726
        for fip in inv.get_idpath(fid):
 
727
            print fip
 
728
 
 
729
 
 
730
class cmd_revision_history(Command):
 
731
    """Display list of revision ids on this branch."""
 
732
    hidden = True
 
733
    def run(self):
 
734
        for patchid in find_branch('.').revision_history():
 
735
            print patchid
 
736
 
 
737
 
 
738
class cmd_directories(Command):
 
739
    """Display list of versioned directories in this branch."""
 
740
    def run(self):
 
741
        for name, ie in find_branch('.').read_working_inventory().directories():
 
742
            if name == '':
 
743
                print '.'
 
744
            else:
 
745
                print name
 
746
 
 
747
 
 
748
class cmd_init(Command):
 
749
    """Make a directory into a versioned branch.
 
750
 
 
751
    Use this to create an empty branch, or before importing an
 
752
    existing project.
 
753
 
 
754
    Recipe for importing a tree of files:
 
755
        cd ~/project
 
756
        bzr init
 
757
        bzr add -v .
 
758
        bzr status
 
759
        bzr commit -m 'imported project'
 
760
    """
 
761
    def run(self):
 
762
        from bzrlib.branch import Branch
 
763
        Branch('.', init=True)
 
764
 
 
765
 
 
766
class cmd_diff(Command):
 
767
    """Show differences in working tree.
 
768
    
 
769
    If files are listed, only the changes in those files are listed.
 
770
    Otherwise, all changes for the tree are listed.
 
771
 
 
772
    TODO: Given two revision arguments, show the difference between them.
 
773
 
 
774
    TODO: Allow diff across branches.
 
775
 
 
776
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
777
          or a graphical diff.
 
778
 
 
779
    TODO: Python difflib is not exactly the same as unidiff; should
 
780
          either fix it up or prefer to use an external diff.
 
781
 
 
782
    TODO: If a directory is given, diff everything under that.
 
783
 
 
784
    TODO: Selected-file diff is inefficient and doesn't show you
 
785
          deleted files.
 
786
 
 
787
    TODO: This probably handles non-Unix newlines poorly.
 
788
    """
 
789
    
 
790
    takes_args = ['file*']
 
791
    takes_options = ['revision', 'diff-options']
 
792
    aliases = ['di', 'dif']
 
793
 
 
794
    def run(self, revision=None, file_list=None, diff_options=None):
 
795
        from bzrlib.diff import show_diff
 
796
 
 
797
        if file_list:
 
798
            b = find_branch(file_list[0])
 
799
            file_list = [b.relpath(f) for f in file_list]
 
800
            if file_list == ['']:
 
801
                # just pointing to top-of-tree
 
802
                file_list = None
 
803
        else:
 
804
            b = find_branch('.')
 
805
 
 
806
        # TODO: Make show_diff support taking 2 arguments
 
807
        base_rev = None
 
808
        if revision is not None:
 
809
            if len(revision) != 1:
 
810
                raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
 
811
            base_rev = revision[0]
 
812
    
 
813
        show_diff(b, base_rev, specific_files=file_list,
 
814
                  external_diff_options=diff_options)
 
815
 
 
816
 
 
817
        
 
818
 
 
819
 
 
820
class cmd_deleted(Command):
 
821
    """List files deleted in the working tree.
 
822
 
 
823
    TODO: Show files deleted since a previous revision, or between two revisions.
 
824
    """
 
825
    def run(self, show_ids=False):
 
826
        b = find_branch('.')
 
827
        old = b.basis_tree()
 
828
        new = b.working_tree()
 
829
 
 
830
        ## TODO: Much more efficient way to do this: read in new
 
831
        ## directories with readdir, rather than stating each one.  Same
 
832
        ## level of effort but possibly much less IO.  (Or possibly not,
 
833
        ## if the directories are very large...)
 
834
 
 
835
        for path, ie in old.inventory.iter_entries():
 
836
            if not new.has_id(ie.file_id):
 
837
                if show_ids:
 
838
                    print '%-50s %s' % (path, ie.file_id)
 
839
                else:
 
840
                    print path
 
841
 
 
842
 
 
843
class cmd_modified(Command):
 
844
    """List files modified in working tree."""
 
845
    hidden = True
 
846
    def run(self):
 
847
        from bzrlib.diff import compare_trees
 
848
 
 
849
        b = find_branch('.')
 
850
        td = compare_trees(b.basis_tree(), b.working_tree())
 
851
 
 
852
        for path, id, kind in td.modified:
 
853
            print path
 
854
 
 
855
 
 
856
 
 
857
class cmd_added(Command):
 
858
    """List files added in working tree."""
 
859
    hidden = True
 
860
    def run(self):
 
861
        b = find_branch('.')
 
862
        wt = b.working_tree()
 
863
        basis_inv = b.basis_tree().inventory
 
864
        inv = wt.inventory
 
865
        for file_id in inv:
 
866
            if file_id in basis_inv:
 
867
                continue
 
868
            path = inv.id2path(file_id)
 
869
            if not os.access(b.abspath(path), os.F_OK):
 
870
                continue
 
871
            print path
 
872
                
 
873
        
 
874
 
 
875
class cmd_root(Command):
 
876
    """Show the tree root directory.
 
877
 
 
878
    The root is the nearest enclosing directory with a .bzr control
 
879
    directory."""
 
880
    takes_args = ['filename?']
 
881
    def run(self, filename=None):
 
882
        """Print the branch root."""
 
883
        b = find_branch(filename)
 
884
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
885
 
 
886
 
 
887
class cmd_log(Command):
 
888
    """Show log of this branch.
 
889
 
 
890
    To request a range of logs, you can use the command -r begin:end
 
891
    -r revision requests a specific revision, -r :end or -r begin: are
 
892
    also valid.
 
893
 
 
894
    --message allows you to give a regular expression, which will be evaluated
 
895
    so that only matching entries will be displayed.
 
896
 
 
897
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
898
  
 
899
    """
 
900
 
 
901
    takes_args = ['filename?']
 
902
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
 
903
    
 
904
    def run(self, filename=None, timezone='original',
 
905
            verbose=False,
 
906
            show_ids=False,
 
907
            forward=False,
 
908
            revision=None,
 
909
            message=None,
 
910
            long=False):
 
911
        from bzrlib.branch import find_branch
 
912
        from bzrlib.log import log_formatter, show_log
 
913
        import codecs
 
914
 
 
915
        direction = (forward and 'forward') or 'reverse'
 
916
        
 
917
        if filename:
 
918
            b = find_branch(filename)
 
919
            fp = b.relpath(filename)
 
920
            if fp:
 
921
                file_id = b.read_working_inventory().path2id(fp)
 
922
            else:
 
923
                file_id = None  # points to branch root
 
924
        else:
 
925
            b = find_branch('.')
 
926
            file_id = None
 
927
 
 
928
        if revision is None:
 
929
            rev1 = None
 
930
            rev2 = None
 
931
        elif len(revision) == 1:
 
932
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
933
        elif len(revision) == 2:
 
934
            rev1 = b.get_revision_info(revision[0])[0]
 
935
            rev2 = b.get_revision_info(revision[1])[0]
 
936
        else:
 
937
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
938
 
 
939
        if rev1 == 0:
 
940
            rev1 = None
 
941
        if rev2 == 0:
 
942
            rev2 = None
 
943
 
 
944
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
945
 
 
946
        # use 'replace' so that we don't abort if trying to write out
 
947
        # in e.g. the default C locale.
 
948
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
949
 
 
950
        if long:
 
951
            log_format = 'long'
 
952
        else:
 
953
            log_format = 'short'
 
954
        lf = log_formatter(log_format,
 
955
                           show_ids=show_ids,
 
956
                           to_file=outf,
 
957
                           show_timezone=timezone)
 
958
 
 
959
        show_log(b,
 
960
                 lf,
 
961
                 file_id,
 
962
                 verbose=verbose,
 
963
                 direction=direction,
 
964
                 start_revision=rev1,
 
965
                 end_revision=rev2,
 
966
                 search=message)
 
967
 
 
968
 
 
969
 
 
970
class cmd_touching_revisions(Command):
 
971
    """Return revision-ids which affected a particular file.
 
972
 
 
973
    A more user-friendly interface is "bzr log FILE"."""
 
974
    hidden = True
 
975
    takes_args = ["filename"]
 
976
    def run(self, filename):
 
977
        b = find_branch(filename)
 
978
        inv = b.read_working_inventory()
 
979
        file_id = inv.path2id(b.relpath(filename))
 
980
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
981
            print "%6d %s" % (revno, what)
 
982
 
 
983
 
 
984
class cmd_ls(Command):
 
985
    """List files in a tree.
 
986
 
 
987
    TODO: Take a revision or remote path and list that tree instead.
 
988
    """
 
989
    hidden = True
 
990
    def run(self, revision=None, verbose=False):
 
991
        b = find_branch('.')
 
992
        if revision == None:
 
993
            tree = b.working_tree()
 
994
        else:
 
995
            tree = b.revision_tree(b.lookup_revision(revision))
 
996
 
 
997
        for fp, fc, kind, fid in tree.list_files():
 
998
            if verbose:
 
999
                if kind == 'directory':
 
1000
                    kindch = '/'
 
1001
                elif kind == 'file':
 
1002
                    kindch = ''
 
1003
                else:
 
1004
                    kindch = '???'
 
1005
 
 
1006
                print '%-8s %s%s' % (fc, fp, kindch)
 
1007
            else:
 
1008
                print fp
 
1009
 
 
1010
 
 
1011
 
 
1012
class cmd_unknowns(Command):
 
1013
    """List unknown files."""
 
1014
    def run(self):
 
1015
        from bzrlib.osutils import quotefn
 
1016
        for f in find_branch('.').unknowns():
 
1017
            print quotefn(f)
 
1018
 
 
1019
 
 
1020
 
 
1021
class cmd_ignore(Command):
 
1022
    """Ignore a command or pattern.
 
1023
 
 
1024
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1025
 
 
1026
    If the pattern contains a slash, it is compared to the whole path
 
1027
    from the branch root.  Otherwise, it is comapred to only the last
 
1028
    component of the path.
 
1029
 
 
1030
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1031
 
 
1032
    Note: wildcards must be quoted from the shell on Unix.
 
1033
 
 
1034
    examples:
 
1035
        bzr ignore ./Makefile
 
1036
        bzr ignore '*.class'
 
1037
    """
 
1038
    takes_args = ['name_pattern']
 
1039
    
 
1040
    def run(self, name_pattern):
 
1041
        from bzrlib.atomicfile import AtomicFile
 
1042
        import os.path
 
1043
 
 
1044
        b = find_branch('.')
 
1045
        ifn = b.abspath('.bzrignore')
 
1046
 
 
1047
        if os.path.exists(ifn):
 
1048
            f = open(ifn, 'rt')
 
1049
            try:
 
1050
                igns = f.read().decode('utf-8')
 
1051
            finally:
 
1052
                f.close()
 
1053
        else:
 
1054
            igns = ''
 
1055
 
 
1056
        # TODO: If the file already uses crlf-style termination, maybe
 
1057
        # we should use that for the newly added lines?
 
1058
 
 
1059
        if igns and igns[-1] != '\n':
 
1060
            igns += '\n'
 
1061
        igns += name_pattern + '\n'
 
1062
 
 
1063
        try:
 
1064
            f = AtomicFile(ifn, 'wt')
 
1065
            f.write(igns.encode('utf-8'))
 
1066
            f.commit()
 
1067
        finally:
 
1068
            f.close()
 
1069
 
 
1070
        inv = b.working_tree().inventory
 
1071
        if inv.path2id('.bzrignore'):
 
1072
            mutter('.bzrignore is already versioned')
 
1073
        else:
 
1074
            mutter('need to make new .bzrignore file versioned')
 
1075
            b.add(['.bzrignore'])
 
1076
 
 
1077
 
 
1078
 
 
1079
class cmd_ignored(Command):
 
1080
    """List ignored files and the patterns that matched them.
 
1081
 
 
1082
    See also: bzr ignore"""
 
1083
    def run(self):
 
1084
        tree = find_branch('.').working_tree()
 
1085
        for path, file_class, kind, file_id in tree.list_files():
 
1086
            if file_class != 'I':
 
1087
                continue
 
1088
            ## XXX: Slightly inefficient since this was already calculated
 
1089
            pat = tree.is_ignored(path)
 
1090
            print '%-50s %s' % (path, pat)
 
1091
 
 
1092
 
 
1093
class cmd_lookup_revision(Command):
 
1094
    """Lookup the revision-id from a revision-number
 
1095
 
 
1096
    example:
 
1097
        bzr lookup-revision 33
 
1098
    """
 
1099
    hidden = True
 
1100
    takes_args = ['revno']
 
1101
    
 
1102
    def run(self, revno):
 
1103
        try:
 
1104
            revno = int(revno)
 
1105
        except ValueError:
 
1106
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1107
 
 
1108
        print find_branch('.').lookup_revision(revno)
 
1109
 
 
1110
 
 
1111
class cmd_export(Command):
 
1112
    """Export past revision to destination directory.
 
1113
 
 
1114
    If no revision is specified this exports the last committed revision.
 
1115
 
 
1116
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1117
    given, try to find the format with the extension. If no extension
 
1118
    is found exports to a directory (equivalent to --format=dir).
 
1119
 
 
1120
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1121
    is given, the top directory will be the root name of the file."""
 
1122
    # TODO: list known exporters
 
1123
    takes_args = ['dest']
 
1124
    takes_options = ['revision', 'format', 'root']
 
1125
    def run(self, dest, revision=None, format=None, root=None):
 
1126
        import os.path
 
1127
        b = find_branch('.')
 
1128
        if revision is None:
 
1129
            rev_id = b.last_patch()
 
1130
        else:
 
1131
            if len(revision) != 1:
 
1132
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1133
            revno, rev_id = b.get_revision_info(revision[0])
 
1134
        t = b.revision_tree(rev_id)
 
1135
        root, ext = os.path.splitext(dest)
 
1136
        if not format:
 
1137
            if ext in (".tar",):
 
1138
                format = "tar"
 
1139
            elif ext in (".gz", ".tgz"):
 
1140
                format = "tgz"
 
1141
            elif ext in (".bz2", ".tbz2"):
 
1142
                format = "tbz2"
 
1143
            else:
 
1144
                format = "dir"
 
1145
        t.export(dest, format, root)
 
1146
 
 
1147
 
 
1148
class cmd_cat(Command):
 
1149
    """Write a file's text from a previous revision."""
 
1150
 
 
1151
    takes_options = ['revision']
 
1152
    takes_args = ['filename']
 
1153
 
 
1154
    def run(self, filename, revision=None):
 
1155
        if revision == None:
 
1156
            raise BzrCommandError("bzr cat requires a revision number")
 
1157
        elif len(revision) != 1:
 
1158
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1159
        b = find_branch('.')
 
1160
        b.print_file(b.relpath(filename), revision[0])
 
1161
 
 
1162
 
 
1163
class cmd_local_time_offset(Command):
 
1164
    """Show the offset in seconds from GMT to local time."""
 
1165
    hidden = True    
 
1166
    def run(self):
 
1167
        print bzrlib.osutils.local_time_offset()
 
1168
 
 
1169
 
 
1170
 
 
1171
class cmd_commit(Command):
 
1172
    """Commit changes into a new revision.
 
1173
 
 
1174
    If selected files are specified, only changes to those files are
 
1175
    committed.  If a directory is specified then its contents are also
 
1176
    committed.
 
1177
 
 
1178
    A selected-file commit may fail in some cases where the committed
 
1179
    tree would be invalid, such as trying to commit a file in a
 
1180
    newly-added directory that is not itself committed.
 
1181
 
 
1182
    TODO: Run hooks on tree to-be-committed, and after commit.
 
1183
 
 
1184
    TODO: Strict commit that fails if there are unknown or deleted files.
 
1185
    """
 
1186
    takes_args = ['selected*']
 
1187
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
1188
    aliases = ['ci', 'checkin']
 
1189
 
 
1190
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1191
            unchanged=False):
 
1192
        from bzrlib.errors import PointlessCommit
 
1193
        from bzrlib.osutils import get_text_message
 
1194
 
 
1195
        ## Warning: shadows builtin file()
 
1196
        if not message and not file:
 
1197
            import cStringIO
 
1198
            stdout = sys.stdout
 
1199
            catcher = cStringIO.StringIO()
 
1200
            sys.stdout = catcher
 
1201
            cmd_status({"file_list":selected_list}, {})
 
1202
            info = catcher.getvalue()
 
1203
            sys.stdout = stdout
 
1204
            message = get_text_message(info)
 
1205
            
 
1206
            if message is None:
 
1207
                raise BzrCommandError("please specify a commit message",
 
1208
                                      ["use either --message or --file"])
 
1209
        elif message and file:
 
1210
            raise BzrCommandError("please specify either --message or --file")
 
1211
        
 
1212
        if file:
 
1213
            import codecs
 
1214
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1215
 
 
1216
        b = find_branch('.')
 
1217
 
 
1218
        try:
 
1219
            b.commit(message, verbose=verbose,
 
1220
                     specific_files=selected_list,
 
1221
                     allow_pointless=unchanged)
 
1222
        except PointlessCommit:
 
1223
            # FIXME: This should really happen before the file is read in;
 
1224
            # perhaps prepare the commit; get the message; then actually commit
 
1225
            raise BzrCommandError("no changes to commit",
 
1226
                                  ["use --unchanged to commit anyhow"])
 
1227
 
 
1228
 
 
1229
class cmd_check(Command):
 
1230
    """Validate consistency of branch history.
 
1231
 
 
1232
    This command checks various invariants about the branch storage to
 
1233
    detect data corruption or bzr bugs.
 
1234
 
 
1235
    If given the --update flag, it will update some optional fields
 
1236
    to help ensure data consistency.
 
1237
    """
 
1238
    takes_args = ['dir?']
 
1239
 
 
1240
    def run(self, dir='.'):
 
1241
        from bzrlib.check import check
 
1242
        check(find_branch(dir))
 
1243
 
 
1244
 
 
1245
 
 
1246
class cmd_upgrade(Command):
 
1247
    """Upgrade branch storage to current format.
 
1248
 
 
1249
    This should normally be used only after the check command tells
 
1250
    you to run it.
 
1251
    """
 
1252
    takes_args = ['dir?']
 
1253
 
 
1254
    def run(self, dir='.'):
 
1255
        from bzrlib.upgrade import upgrade
 
1256
        upgrade(find_branch(dir))
 
1257
 
 
1258
 
 
1259
 
 
1260
class cmd_whoami(Command):
 
1261
    """Show bzr user id."""
 
1262
    takes_options = ['email']
 
1263
    
 
1264
    def run(self, email=False):
 
1265
        if email:
 
1266
            print bzrlib.osutils.user_email()
 
1267
        else:
 
1268
            print bzrlib.osutils.username()
 
1269
 
 
1270
 
 
1271
class cmd_selftest(Command):
 
1272
    """Run internal test suite"""
 
1273
    hidden = True
 
1274
    def run(self):
 
1275
        from bzrlib.selftest import selftest
 
1276
        return int(not selftest())
 
1277
 
 
1278
 
 
1279
class cmd_version(Command):
 
1280
    """Show version of bzr."""
 
1281
    def run(self):
 
1282
        show_version()
 
1283
 
 
1284
def show_version():
 
1285
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1286
    # is bzrlib itself in a branch?
 
1287
    bzrrev = bzrlib.get_bzr_revision()
 
1288
    if bzrrev:
 
1289
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
1290
    print bzrlib.__copyright__
 
1291
    print "http://bazaar-ng.org/"
 
1292
    print
 
1293
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1294
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1295
    print "General Public License version 2 or later."
 
1296
 
 
1297
 
 
1298
class cmd_rocks(Command):
 
1299
    """Statement of optimism."""
 
1300
    hidden = True
 
1301
    def run(self):
 
1302
        print "it sure does!"
 
1303
 
 
1304
def parse_spec(spec):
 
1305
    """
 
1306
    >>> parse_spec(None)
 
1307
    [None, None]
 
1308
    >>> parse_spec("./")
 
1309
    ['./', None]
 
1310
    >>> parse_spec("../@")
 
1311
    ['..', -1]
 
1312
    >>> parse_spec("../f/@35")
 
1313
    ['../f', 35]
 
1314
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
1315
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
1316
    """
 
1317
    if spec is None:
 
1318
        return [None, None]
 
1319
    if '/@' in spec:
 
1320
        parsed = spec.split('/@')
 
1321
        assert len(parsed) == 2
 
1322
        if parsed[1] == "":
 
1323
            parsed[1] = -1
 
1324
        else:
 
1325
            try:
 
1326
                parsed[1] = int(parsed[1])
 
1327
            except ValueError:
 
1328
                pass # We can allow stuff like ./@revid:blahblahblah
 
1329
            else:
 
1330
                assert parsed[1] >=0
 
1331
    else:
 
1332
        parsed = [spec, None]
 
1333
    return parsed
 
1334
 
 
1335
 
 
1336
 
 
1337
class cmd_merge(Command):
 
1338
    """Perform a three-way merge of trees.
 
1339
    
 
1340
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1341
    are specified using standard paths or urls.  No component of a directory
 
1342
    path may begin with '@'.
 
1343
    
 
1344
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1345
 
 
1346
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1347
    branch directory and revno is the revision within that branch.  If no revno
 
1348
    is specified, the latest revision is used.
 
1349
 
 
1350
    Revision examples: './@127', 'foo/@', '../@1'
 
1351
 
 
1352
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1353
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1354
    as the BASE.
 
1355
 
 
1356
    merge refuses to run if there are any uncommitted changes, unless
 
1357
    --force is given.
 
1358
    """
 
1359
    takes_args = ['other_spec', 'base_spec?']
 
1360
    takes_options = ['force']
 
1361
 
 
1362
    def run(self, other_spec, base_spec=None, force=False):
 
1363
        from bzrlib.merge import merge
 
1364
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1365
              check_clean=(not force))
 
1366
 
 
1367
 
 
1368
 
 
1369
class cmd_revert(Command):
 
1370
    """Restore selected files from a previous revision.
 
1371
    """
 
1372
    takes_args = ['file+']
 
1373
    def run(self, file_list):
 
1374
        from bzrlib.branch import find_branch
 
1375
        
 
1376
        if not file_list:
 
1377
            file_list = ['.']
 
1378
            
 
1379
        b = find_branch(file_list[0])
 
1380
 
 
1381
        b.revert([b.relpath(f) for f in file_list])
 
1382
 
 
1383
 
 
1384
class cmd_merge_revert(Command):
 
1385
    """Reverse all changes since the last commit.
 
1386
 
 
1387
    Only versioned files are affected.
 
1388
 
 
1389
    TODO: Store backups of any files that will be reverted, so
 
1390
          that the revert can be undone.          
 
1391
    """
 
1392
    takes_options = ['revision']
 
1393
 
 
1394
    def run(self, revision=None):
 
1395
        from bzrlib.merge import merge
 
1396
        if revision is None:
 
1397
            revision = [-1]
 
1398
        elif len(revision) != 1:
 
1399
            raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
 
1400
        merge(('.', revision[0]), parse_spec('.'),
 
1401
              check_clean=False,
 
1402
              ignore_zero=True)
 
1403
 
 
1404
 
 
1405
class cmd_assert_fail(Command):
 
1406
    """Test reporting of assertion failures"""
 
1407
    hidden = True
 
1408
    def run(self):
 
1409
        assert False, "always fails"
 
1410
 
 
1411
 
 
1412
class cmd_help(Command):
 
1413
    """Show help on a command or other topic.
 
1414
 
 
1415
    For a list of all available commands, say 'bzr help commands'."""
 
1416
    takes_args = ['topic?']
 
1417
    aliases = ['?']
 
1418
    
 
1419
    def run(self, topic=None):
 
1420
        import help
 
1421
        help.help(topic)
 
1422
 
 
1423
 
 
1424
 
 
1425
 
 
1426
class cmd_plugins(Command):
 
1427
    """List plugins"""
 
1428
    hidden = True
 
1429
    def run(self):
 
1430
        import bzrlib.plugin
 
1431
        from inspect import getdoc
 
1432
        from pprint import pprint
 
1433
        for plugin in bzrlib.plugin.all_plugins:
 
1434
            print plugin.__path__[0]
 
1435
            d = getdoc(plugin)
 
1436
            if d:
 
1437
                print '\t', d.split('\n')[0]
 
1438
 
 
1439
        #pprint(bzrlib.plugin.all_plugins)
 
1440
 
 
1441
 
 
1442
 
 
1443
# list of all available options; the rhs can be either None for an
 
1444
# option that takes no argument, or a constructor function that checks
 
1445
# the type.
 
1446
OPTIONS = {
 
1447
    'all':                    None,
 
1448
    'diff-options':           str,
 
1449
    'help':                   None,
 
1450
    'file':                   unicode,
 
1451
    'force':                  None,
 
1452
    'format':                 unicode,
 
1453
    'forward':                None,
 
1454
    'message':                unicode,
 
1455
    'no-recurse':             None,
 
1456
    'profile':                None,
 
1457
    'revision':               _parse_revision_str,
 
1458
    'show-ids':               None,
 
1459
    'timezone':               str,
 
1460
    'verbose':                None,
 
1461
    'version':                None,
 
1462
    'email':                  None,
 
1463
    'unchanged':              None,
 
1464
    'update':                 None,
 
1465
    'long':                   None,
 
1466
    'root':                   str,
 
1467
    }
 
1468
 
 
1469
SHORT_OPTIONS = {
 
1470
    'F':                      'file', 
 
1471
    'h':                      'help',
 
1472
    'm':                      'message',
 
1473
    'r':                      'revision',
 
1474
    'v':                      'verbose',
 
1475
    'l':                      'long',
 
1476
}
 
1477
 
 
1478
 
 
1479
def parse_args(argv):
 
1480
    """Parse command line.
 
1481
    
 
1482
    Arguments and options are parsed at this level before being passed
 
1483
    down to specific command handlers.  This routine knows, from a
 
1484
    lookup table, something about the available options, what optargs
 
1485
    they take, and which commands will accept them.
 
1486
 
 
1487
    >>> parse_args('--help'.split())
 
1488
    ([], {'help': True})
 
1489
    >>> parse_args('--version'.split())
 
1490
    ([], {'version': True})
 
1491
    >>> parse_args('status --all'.split())
 
1492
    (['status'], {'all': True})
 
1493
    >>> parse_args('commit --message=biter'.split())
 
1494
    (['commit'], {'message': u'biter'})
 
1495
    >>> parse_args('log -r 500'.split())
 
1496
    (['log'], {'revision': [500]})
 
1497
    >>> parse_args('log -r500..600'.split())
 
1498
    (['log'], {'revision': [500, 600]})
 
1499
    >>> parse_args('log -vr500..600'.split())
 
1500
    (['log'], {'verbose': True, 'revision': [500, 600]})
 
1501
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
 
1502
    (['log'], {'revision': ['v500', 600]})
 
1503
    """
 
1504
    args = []
 
1505
    opts = {}
 
1506
 
 
1507
    # TODO: Maybe handle '--' to end options?
 
1508
 
 
1509
    while argv:
 
1510
        a = argv.pop(0)
 
1511
        if a[0] == '-':
 
1512
            # option names must not be unicode
 
1513
            a = str(a)
 
1514
            optarg = None
 
1515
            if a[1] == '-':
 
1516
                mutter("  got option %r" % a)
 
1517
                if '=' in a:
 
1518
                    optname, optarg = a[2:].split('=', 1)
 
1519
                else:
 
1520
                    optname = a[2:]
 
1521
                if optname not in OPTIONS:
 
1522
                    raise BzrError('unknown long option %r' % a)
 
1523
            else:
 
1524
                shortopt = a[1:]
 
1525
                if shortopt in SHORT_OPTIONS:
 
1526
                    # Multi-character options must have a space to delimit
 
1527
                    # their value
 
1528
                    optname = SHORT_OPTIONS[shortopt]
 
1529
                else:
 
1530
                    # Single character short options, can be chained,
 
1531
                    # and have their value appended to their name
 
1532
                    shortopt = a[1:2]
 
1533
                    if shortopt not in SHORT_OPTIONS:
 
1534
                        # We didn't find the multi-character name, and we
 
1535
                        # didn't find the single char name
 
1536
                        raise BzrError('unknown short option %r' % a)
 
1537
                    optname = SHORT_OPTIONS[shortopt]
 
1538
 
 
1539
                    if a[2:]:
 
1540
                        # There are extra things on this option
 
1541
                        # see if it is the value, or if it is another
 
1542
                        # short option
 
1543
                        optargfn = OPTIONS[optname]
 
1544
                        if optargfn is None:
 
1545
                            # This option does not take an argument, so the
 
1546
                            # next entry is another short option, pack it back
 
1547
                            # into the list
 
1548
                            argv.insert(0, '-' + a[2:])
 
1549
                        else:
 
1550
                            # This option takes an argument, so pack it
 
1551
                            # into the array
 
1552
                            optarg = a[2:]
 
1553
            
 
1554
            if optname in opts:
 
1555
                # XXX: Do we ever want to support this, e.g. for -r?
 
1556
                raise BzrError('repeated option %r' % a)
 
1557
                
 
1558
            optargfn = OPTIONS[optname]
 
1559
            if optargfn:
 
1560
                if optarg == None:
 
1561
                    if not argv:
 
1562
                        raise BzrError('option %r needs an argument' % a)
 
1563
                    else:
 
1564
                        optarg = argv.pop(0)
 
1565
                opts[optname] = optargfn(optarg)
 
1566
            else:
 
1567
                if optarg != None:
 
1568
                    raise BzrError('option %r takes no argument' % optname)
 
1569
                opts[optname] = True
 
1570
        else:
 
1571
            args.append(a)
 
1572
 
 
1573
    return args, opts
 
1574
 
 
1575
 
 
1576
 
 
1577
 
 
1578
def _match_argform(cmd, takes_args, args):
 
1579
    argdict = {}
 
1580
 
 
1581
    # step through args and takes_args, allowing appropriate 0-many matches
 
1582
    for ap in takes_args:
 
1583
        argname = ap[:-1]
 
1584
        if ap[-1] == '?':
 
1585
            if args:
 
1586
                argdict[argname] = args.pop(0)
 
1587
        elif ap[-1] == '*': # all remaining arguments
 
1588
            if args:
 
1589
                argdict[argname + '_list'] = args[:]
 
1590
                args = []
 
1591
            else:
 
1592
                argdict[argname + '_list'] = None
 
1593
        elif ap[-1] == '+':
 
1594
            if not args:
 
1595
                raise BzrCommandError("command %r needs one or more %s"
 
1596
                        % (cmd, argname.upper()))
 
1597
            else:
 
1598
                argdict[argname + '_list'] = args[:]
 
1599
                args = []
 
1600
        elif ap[-1] == '$': # all but one
 
1601
            if len(args) < 2:
 
1602
                raise BzrCommandError("command %r needs one or more %s"
 
1603
                        % (cmd, argname.upper()))
 
1604
            argdict[argname + '_list'] = args[:-1]
 
1605
            args[:-1] = []                
 
1606
        else:
 
1607
            # just a plain arg
 
1608
            argname = ap
 
1609
            if not args:
 
1610
                raise BzrCommandError("command %r requires argument %s"
 
1611
                        % (cmd, argname.upper()))
 
1612
            else:
 
1613
                argdict[argname] = args.pop(0)
 
1614
            
 
1615
    if args:
 
1616
        raise BzrCommandError("extra argument to command %s: %s"
 
1617
                              % (cmd, args[0]))
 
1618
 
 
1619
    return argdict
 
1620
 
 
1621
 
 
1622
def _parse_master_args(argv):
 
1623
    """Parse the arguments that always go with the original command.
 
1624
    These are things like bzr --no-plugins, etc.
 
1625
 
 
1626
    There are now 2 types of option flags. Ones that come *before* the command,
 
1627
    and ones that come *after* the command.
 
1628
    Ones coming *before* the command are applied against all possible commands.
 
1629
    And are generally applied before plugins are loaded.
 
1630
 
 
1631
    The current list are:
 
1632
        --builtin   Allow plugins to load, but don't let them override builtin commands,
 
1633
                    they will still be allowed if they do not override a builtin.
 
1634
        --no-plugins    Don't load any plugins. This lets you get back to official source
 
1635
                        behavior.
 
1636
        --profile   Enable the hotspot profile before running the command.
 
1637
                    For backwards compatibility, this is also a non-master option.
 
1638
        --version   Spit out the version of bzr that is running and exit.
 
1639
                    This is also a non-master option.
 
1640
        --help      Run help and exit, also a non-master option (I think that should stay, though)
 
1641
 
 
1642
    >>> argv, opts = _parse_master_args(['bzr', '--test'])
 
1643
    Traceback (most recent call last):
 
1644
    ...
 
1645
    BzrCommandError: Invalid master option: 'test'
 
1646
    >>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
 
1647
    >>> print argv
 
1648
    ['command']
 
1649
    >>> print opts['version']
 
1650
    True
 
1651
    >>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
 
1652
    >>> print argv
 
1653
    ['command', '--more-options']
 
1654
    >>> print opts['profile']
 
1655
    True
 
1656
    >>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
 
1657
    >>> print argv
 
1658
    ['command']
 
1659
    >>> print opts['no-plugins']
 
1660
    True
 
1661
    >>> print opts['profile']
 
1662
    False
 
1663
    >>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
 
1664
    >>> print argv
 
1665
    ['command', '--profile']
 
1666
    >>> print opts['profile']
 
1667
    False
 
1668
    """
 
1669
    master_opts = {'builtin':False,
 
1670
        'no-plugins':False,
 
1671
        'version':False,
 
1672
        'profile':False,
 
1673
        'help':False
 
1674
    }
 
1675
 
 
1676
    # This is the point where we could hook into argv[0] to determine
 
1677
    # what front-end is supposed to be run
 
1678
    # For now, we are just ignoring it.
 
1679
    cmd_name = argv.pop(0)
 
1680
    for arg in argv[:]:
 
1681
        if arg[:2] != '--': # at the first non-option, we return the rest
 
1682
            break
 
1683
        arg = arg[2:] # Remove '--'
 
1684
        if arg not in master_opts:
 
1685
            # We could say that this is not an error, that we should
 
1686
            # just let it be handled by the main section instead
 
1687
            raise BzrCommandError('Invalid master option: %r' % arg)
 
1688
        argv.pop(0) # We are consuming this entry
 
1689
        master_opts[arg] = True
 
1690
    return argv, master_opts
 
1691
 
 
1692
 
 
1693
 
 
1694
def run_bzr(argv):
 
1695
    """Execute a command.
 
1696
 
 
1697
    This is similar to main(), but without all the trappings for
 
1698
    logging and error handling.  
 
1699
    """
 
1700
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1701
    
 
1702
    try:
 
1703
        # some options like --builtin and --no-plugins have special effects
 
1704
        argv, master_opts = _parse_master_args(argv)
 
1705
        if not master_opts['no-plugins']:
 
1706
            from bzrlib.plugin import load_plugins
 
1707
            load_plugins()
 
1708
 
 
1709
        args, opts = parse_args(argv)
 
1710
 
 
1711
        if master_opts['help']:
 
1712
            from bzrlib.help import help
 
1713
            if argv:
 
1714
                help(argv[0])
 
1715
            else:
 
1716
                help()
 
1717
            return 0            
 
1718
            
 
1719
        if 'help' in opts:
 
1720
            from bzrlib.help import help
 
1721
            if args:
 
1722
                help(args[0])
 
1723
            else:
 
1724
                help()
 
1725
            return 0
 
1726
        elif 'version' in opts:
 
1727
            show_version()
 
1728
            return 0
 
1729
        elif args and args[0] == 'builtin':
 
1730
            include_plugins=False
 
1731
            args = args[1:]
 
1732
        cmd = str(args.pop(0))
 
1733
    except IndexError:
 
1734
        import help
 
1735
        help.help()
 
1736
        return 1
 
1737
          
 
1738
 
 
1739
    plugins_override = not (master_opts['builtin'])
 
1740
    canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
 
1741
 
 
1742
    profile = master_opts['profile']
 
1743
    # For backwards compatibility, I would rather stick with --profile being a
 
1744
    # master/global option
 
1745
    if 'profile' in opts:
 
1746
        profile = True
 
1747
        del opts['profile']
 
1748
 
 
1749
    # check options are reasonable
 
1750
    allowed = cmd_class.takes_options
 
1751
    for oname in opts:
 
1752
        if oname not in allowed:
 
1753
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1754
                                  % (oname, cmd))
 
1755
 
 
1756
    # mix arguments and options into one dictionary
 
1757
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1758
    cmdopts = {}
 
1759
    for k, v in opts.items():
 
1760
        cmdopts[k.replace('-', '_')] = v
 
1761
 
 
1762
    if profile:
 
1763
        import hotshot, tempfile
 
1764
        pffileno, pfname = tempfile.mkstemp()
 
1765
        try:
 
1766
            prof = hotshot.Profile(pfname)
 
1767
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1768
            prof.close()
 
1769
 
 
1770
            import hotshot.stats
 
1771
            stats = hotshot.stats.load(pfname)
 
1772
            #stats.strip_dirs()
 
1773
            stats.sort_stats('time')
 
1774
            ## XXX: Might like to write to stderr or the trace file instead but
 
1775
            ## print_stats seems hardcoded to stdout
 
1776
            stats.print_stats(20)
 
1777
            
 
1778
            return ret.status
 
1779
 
 
1780
        finally:
 
1781
            os.close(pffileno)
 
1782
            os.remove(pfname)
 
1783
    else:
 
1784
        return cmd_class(cmdopts, cmdargs).status 
 
1785
 
 
1786
 
 
1787
def _report_exception(summary, quiet=False):
 
1788
    import traceback
 
1789
    log_error('bzr: ' + summary)
 
1790
    bzrlib.trace.log_exception()
 
1791
 
 
1792
    if not quiet:
 
1793
        tb = sys.exc_info()[2]
 
1794
        exinfo = traceback.extract_tb(tb)
 
1795
        if exinfo:
 
1796
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1797
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1798
 
 
1799
 
 
1800
 
 
1801
def main(argv):
 
1802
    
 
1803
    bzrlib.trace.open_tracefile(argv)
 
1804
 
 
1805
    try:
 
1806
        try:
 
1807
            try:
 
1808
                return run_bzr(argv)
 
1809
            finally:
 
1810
                # do this here inside the exception wrappers to catch EPIPE
 
1811
                sys.stdout.flush()
 
1812
        except BzrError, e:
 
1813
            quiet = isinstance(e, (BzrCommandError))
 
1814
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1815
            if len(e.args) > 1:
 
1816
                for h in e.args[1]:
 
1817
                    # some explanation or hints
 
1818
                    log_error('  ' + h)
 
1819
            return 1
 
1820
        except AssertionError, e:
 
1821
            msg = 'assertion failed'
 
1822
            if str(e):
 
1823
                msg += ': ' + str(e)
 
1824
            _report_exception(msg)
 
1825
            return 2
 
1826
        except KeyboardInterrupt, e:
 
1827
            _report_exception('interrupted', quiet=True)
 
1828
            return 2
 
1829
        except Exception, e:
 
1830
            import errno
 
1831
            quiet = False
 
1832
            if (isinstance(e, IOError) 
 
1833
                and hasattr(e, 'errno')
 
1834
                and e.errno == errno.EPIPE):
 
1835
                quiet = True
 
1836
                msg = 'broken pipe'
 
1837
            else:
 
1838
                msg = str(e).rstrip('\n')
 
1839
            _report_exception(msg, quiet)
 
1840
            return 2
 
1841
    finally:
 
1842
        bzrlib.trace.close_trace()
 
1843
 
 
1844
 
 
1845
if __name__ == '__main__':
 
1846
    sys.exit(main(sys.argv))