/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-15 22:55:36 UTC
  • Revision ID: mbp@sourcefrog.net-20050715225536-47d68404108e4eb8
- shell script to set up a weave merge test case

Show diffs side-by-side

added added

removed removed

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