/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Aaron Bentley
  • Date: 2005-07-15 13:43:54 UTC
  • mto: This revision was merged to the branch mainline in revision 923.
  • Revision ID: abentley@panoramicfeedback.com-20050715134354-78f2bca607acb415
Fixed log -v (mostly)

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