/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 06:13:18 UTC
  • mfrom: (unknown (missing))
  • Revision ID: mbp@sourcefrog.net-20050711061318-80557a9f045b1f38
- merge john's revision-naming code

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