← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-06-20 03:29:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050620032921-240d0ade23545055
- remove redundant precursor check

Show diffs side-by-side

added added

removed removed

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