~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-27 14:19:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050727141923-9f4f14835da8a2db
- clean up code that loads modules to test, taking advantage of less broken
  testLoader in python 2.4

Show diffs side-by-side

added added

removed removed

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