/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:41:00 UTC
  • mfrom: (unknown (missing))
  • Revision ID: mbp@sourcefrog.net-20050711064100-c2eb947e0212f487
- patch from john to search for matching commits

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