~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-23 19:05:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2036.
  • Revision ID: john@arbash-meinel.com-20060923190544-c3f625a5bc5589ab
paths are always forward slashed for python zipfiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/python
2
 
 
3
 
 
4
 
# Copyright (C) 2004, 2005 by Martin Pool
5
 
# Copyright (C) 2005 by Canonical Ltd
6
 
 
7
 
 
 
1
# Copyright (C) 2006 by Canonical Ltd
 
2
#
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
10
5
# the Free Software Foundation; either version 2 of the License, or
11
6
# (at your option) any later version.
12
 
 
 
7
#
13
8
# This program is distributed in the hope that it will be useful,
14
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
11
# GNU General Public License for more details.
17
 
 
 
12
#
18
13
# You should have received a copy of the GNU General Public License
19
14
# along with this program; if not, write to the Free Software
20
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
16
 
22
 
"""Bazaar-NG -- a free distributed version-control tool
23
 
 
24
 
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
 
 
26
 
Current limitation include:
27
 
 
28
 
* Metadata format is not stable yet -- you may need to
29
 
  discard history in the future.
30
 
 
31
 
* No handling of subdirectories, symlinks or any non-text files.
32
 
 
33
 
* Insufficient error handling.
34
 
 
35
 
* Many commands unimplemented or partially implemented.
36
 
 
37
 
* Space-inefficient storage.
38
 
 
39
 
* No merge operators yet.
40
 
 
41
 
Interesting commands::
42
 
 
43
 
  bzr help
44
 
       Show summary help screen
45
 
  bzr version
46
 
       Show software version/licence/non-warranty.
47
 
  bzr init
48
 
       Start versioning the current directory
49
 
  bzr add FILE...
50
 
       Make files versioned.
51
 
  bzr log
52
 
       Show revision history.
53
 
  bzr diff
54
 
       Show changes from last revision to working copy.
55
 
  bzr commit -m 'MESSAGE'
56
 
       Store current state as new revision.
57
 
  bzr export REVNO DESTINATION
58
 
       Export the branch state at a previous version.
59
 
  bzr status
60
 
       Show summary of pending changes.
61
 
  bzr remove FILE...
62
 
       Make a file not versioned.
63
 
"""
64
 
 
65
 
# not currently working:
66
 
#  bzr check
67
 
#       Run internal consistency checks.
68
 
#  bzr info
69
 
#       Show some information about this branch.
70
 
 
71
 
 
72
 
 
73
 
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
 
__author__ = "Martin Pool <mbp@canonical.com>"
75
 
__docformat__ = "restructuredtext en"
76
 
__version__ = '0.0.0'
77
 
 
78
 
 
79
 
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
 
import traceback, socket, fnmatch, difflib
81
 
from os import path
82
 
from sets import Set
83
 
from pprint import pprint
84
 
from stat import *
85
 
from glob import glob
 
17
 
 
18
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
 
20
 
 
21
# TODO: Define arguments by objects, rather than just using names.
 
22
# Those objects can specify the expected type of the argument, which
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
 
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
 
31
import codecs
 
32
import errno
 
33
import os
 
34
from warnings import warn
 
35
import sys
86
36
 
87
37
import bzrlib
88
 
from bzrlib.store import ImmutableStore
89
 
from bzrlib.trace import mutter, note, log_error
90
 
from bzrlib.errors import bailout, BzrError
91
 
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
 
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
 
from bzrlib.revision import Revision
94
 
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
 
     format_date
96
 
 
97
 
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
98
 
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
99
 
 
100
 
## standard representation
101
 
NONE_STRING = '(none)'
102
 
EMPTY = 'empty'
103
 
 
104
 
 
105
 
## TODO: Perhaps a different version of inventory commands that
106
 
## returns iterators...
107
 
 
108
 
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
109
 
 
110
 
## TODO: Some kind of locking on branches.  Perhaps there should be a
111
 
## parameter to the branch object saying whether we want a read or
112
 
## write lock; release it from destructor.  Perhaps don't even need a
113
 
## read lock to look at immutable objects?
114
 
 
115
 
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
 
## to compare output?
117
 
 
118
 
 
119
 
 
120
 
 
121
 
######################################################################
122
 
# check status
123
 
 
124
 
 
125
 
def cmd_status(all=False):
126
 
    """Display status summary.
127
 
 
128
 
    For each file there is a single line giving its file state and name.
129
 
    The name is that in the current revision unless it is deleted or
130
 
    missing, in which case the old name is shown.
131
 
 
132
 
    :todo: Don't show unchanged files unless ``--all`` is given?
133
 
    """
134
 
    Branch('.').show_status(show_all=all)
135
 
 
136
 
 
137
 
 
138
 
######################################################################
139
 
# examining history
140
 
def cmd_get_revision(revision_id):
141
 
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
142
 
 
143
 
 
144
 
def cmd_get_inventory(inventory_id):
145
 
    """Return inventory in XML by hash"""
146
 
    Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
147
 
 
148
 
 
149
 
def cmd_get_revision_inventory(revision_id):
150
 
    """Output inventory for a revision."""
151
 
    b = Branch('.')
152
 
    b.get_revision_inventory(revision_id).write_xml(sys.stdout)
153
 
 
154
 
 
155
 
def cmd_get_file_text(text_id):
156
 
    """Get contents of a file by hash."""
157
 
    sf = Branch('.').text_store[text_id]
158
 
    pumpfile(sf, sys.stdout)
159
 
 
160
 
 
161
 
 
162
 
######################################################################
163
 
# commands
164
 
    
165
 
 
166
 
def cmd_revno():
167
 
    """Show number of revisions on this branch"""
168
 
    print Branch('.').revno()
169
 
    
170
 
 
171
 
def cmd_add(file_list, verbose=False):
172
 
    """Add specified files.
173
 
    
174
 
    Fails if the files are already added.
175
 
    """
176
 
    Branch('.').add(file_list, verbose=verbose)
177
 
 
178
 
 
179
 
def cmd_inventory(revision=None):
180
 
    """Show inventory of the current working copy."""
181
 
    ## TODO: Also optionally show a previous inventory
182
 
    ## TODO: Format options
183
 
    b = Branch('.')
184
 
    if revision == None:
185
 
        inv = b.read_working_inventory()
186
 
    else:
187
 
        inv = b.get_revision_inventory(b.lookup_revision(revision))
188
 
        
189
 
    for path, entry in inv.iter_entries():
190
 
        print '%-50s %s' % (entry.file_id, path)
191
 
 
192
 
 
193
 
 
194
 
def cmd_info():
195
 
    b = Branch('.')
196
 
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
197
 
    print 'revision number:', b.revno()
198
 
    print 'number of versioned files:', len(b.read_working_inventory())
199
 
 
200
 
 
201
 
def cmd_remove(file_list, verbose=False):
202
 
    Branch('.').remove(file_list, verbose=verbose)
203
 
 
204
 
 
205
 
 
206
 
def cmd_file_id(filename):
207
 
    i = Branch('.').read_working_inventory().path2id(filename)
208
 
    if i is None:
209
 
        bailout("%s is not a versioned file" % filename)
210
 
    else:
211
 
        print i
212
 
 
213
 
 
214
 
def cmd_find_filename(fileid):
215
 
    n = find_filename(fileid)
216
 
    if n is None:
217
 
        bailout("%s is not a live file id" % fileid)
218
 
    else:
219
 
        print n
220
 
 
221
 
 
222
 
def cmd_revision_history():
223
 
    for patchid in Branch('.').revision_history():
224
 
        print patchid
225
 
 
226
 
 
227
 
 
228
 
def cmd_init():
229
 
    # TODO: Check we're not already in a working directory?  At the
230
 
    # moment you'll get an ugly error.
231
 
    
232
 
    # TODO: What if we're in a subdirectory of a branch?  Would like
233
 
    # to allow that, but then the parent may need to understand that
234
 
    # the children have disappeared, or should they be versioned in
235
 
    # both?
236
 
 
237
 
    # TODO: Take an argument/option for branch name.
238
 
    Branch('.', init=True)
239
 
 
240
 
 
241
 
def cmd_diff(revision=None):
242
 
    """Show diff from basis to working copy.
243
 
 
244
 
    :todo: Take one or two revision arguments, look up those trees,
245
 
           and diff them.
246
 
 
247
 
    :todo: Allow diff across branches.
248
 
 
249
 
    :todo: Mangle filenames in diff to be more relevant.
250
 
 
251
 
    :todo: Shouldn't be in the cmd function.
252
 
    """
253
 
 
254
 
    b = Branch('.')
255
 
 
256
 
    if revision == None:
257
 
        old_tree = b.basis_tree()
258
 
    else:
259
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
260
 
        
261
 
    new_tree = b.working_tree()
262
 
    old_inv = old_tree.inventory
263
 
    new_inv = new_tree.inventory
264
 
 
265
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
266
 
    old_label = ''
267
 
    new_label = ''
268
 
 
269
 
    DEVNULL = '/dev/null'
270
 
    # Windows users, don't panic about this filename -- it is a
271
 
    # special signal to GNU patch that the file should be created or
272
 
    # deleted respectively.
273
 
 
274
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
275
 
    # be usefully made into a much faster special case.
276
 
 
277
 
    # TODO: Better to return them in sorted order I think.
278
 
    
279
 
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
280
 
        d = None
281
 
 
282
 
        # Don't show this by default; maybe do it if an option is passed
283
 
        # idlabel = '      {%s}' % fid
284
 
        idlabel = ''
285
 
 
286
 
        # FIXME: Something about the diff format makes patch unhappy
287
 
        # with newly-added files.
288
 
 
289
 
        def diffit(*a, **kw):
290
 
            sys.stdout.writelines(difflib.unified_diff(*a, **kw))
291
 
            print
292
 
        
293
 
        if file_state in ['.', '?', 'I']:
294
 
            continue
295
 
        elif file_state == 'A':
296
 
            print '*** added %s %r' % (kind, new_name)
297
 
            if kind == 'file':
298
 
                diffit([],
299
 
                       new_tree.get_file(fid).readlines(),
300
 
                       fromfile=DEVNULL,
301
 
                       tofile=new_label + new_name + idlabel)
302
 
        elif file_state == 'D':
303
 
            assert isinstance(old_name, types.StringTypes)
304
 
            print '*** deleted %s %r' % (kind, old_name)
305
 
            if kind == 'file':
306
 
                diffit(old_tree.get_file(fid).readlines(), [],
307
 
                       fromfile=old_label + old_name + idlabel,
308
 
                       tofile=DEVNULL)
309
 
        elif file_state in ['M', 'R']:
310
 
            if file_state == 'M':
311
 
                assert kind == 'file'
312
 
                assert old_name == new_name
313
 
                print '*** modified %s %r' % (kind, new_name)
314
 
            elif file_state == 'R':
315
 
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
316
 
 
317
 
            if kind == 'file':
318
 
                diffit(old_tree.get_file(fid).readlines(),
319
 
                       new_tree.get_file(fid).readlines(),
320
 
                       fromfile=old_label + old_name + idlabel,
321
 
                       tofile=new_label + new_name)
322
 
        else:
323
 
            bailout("can't represent state %s {%s}" % (file_state, fid))
324
 
 
325
 
 
326
 
 
327
 
def cmd_log(timezone='original'):
328
 
    """Show log of this branch.
329
 
 
330
 
    :todo: Options for utc; to show ids; to limit range; etc.
331
 
    """
332
 
    Branch('.').write_log(show_timezone=timezone)
333
 
 
334
 
 
335
 
def cmd_ls(revision=None, verbose=False):
336
 
    """List files in a tree.
337
 
 
338
 
    :todo: Take a revision or remote path and list that tree instead.
339
 
    """
340
 
    b = Branch('.')
341
 
    if revision == None:
342
 
        tree = b.working_tree()
343
 
    else:
344
 
        tree = b.revision_tree(b.lookup_revision(revision))
345
 
        
346
 
    for fp, fc, kind, fid in tree.list_files():
347
 
        if verbose:
348
 
            if kind == 'directory':
349
 
                kindch = '/'
350
 
            elif kind == 'file':
351
 
                kindch = ''
 
38
import bzrlib.errors as errors
 
39
from bzrlib.errors import (BzrError,
 
40
                           BzrCommandError,
 
41
                           BzrCheckError,
 
42
                           NotBranchError)
 
43
from bzrlib import option
 
44
from bzrlib.option import Option
 
45
import bzrlib.osutils
 
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
 
47
import bzrlib.trace
 
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
 
49
 
 
50
plugin_cmds = {}
 
51
 
 
52
 
 
53
def register_command(cmd, decorate=False):
 
54
    """Utility function to help register a command
 
55
 
 
56
    :param cmd: Command subclass to register
 
57
    :param decorate: If true, allow overriding an existing command
 
58
        of the same name; the old command is returned by this function.
 
59
        Otherwise it is an error to try to override an existing command.
 
60
    """
 
61
    global plugin_cmds
 
62
    k = cmd.__name__
 
63
    if k.startswith("cmd_"):
 
64
        k_unsquished = _unsquish_command_name(k)
 
65
    else:
 
66
        k_unsquished = k
 
67
    if k_unsquished not in plugin_cmds:
 
68
        plugin_cmds[k_unsquished] = cmd
 
69
        mutter('registered plugin command %s', k_unsquished)
 
70
        if decorate and k_unsquished in builtin_command_names():
 
71
            return _builtin_commands()[k_unsquished]
 
72
    elif decorate:
 
73
        result = plugin_cmds[k_unsquished]
 
74
        plugin_cmds[k_unsquished] = cmd
 
75
        return result
 
76
    else:
 
77
        log_error('Two plugins defined the same command: %r' % k)
 
78
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
79
 
 
80
 
 
81
def _squish_command_name(cmd):
 
82
    return 'cmd_' + cmd.replace('-', '_')
 
83
 
 
84
 
 
85
def _unsquish_command_name(cmd):
 
86
    assert cmd.startswith("cmd_")
 
87
    return cmd[4:].replace('_','-')
 
88
 
 
89
 
 
90
def _builtin_commands():
 
91
    import bzrlib.builtins
 
92
    r = {}
 
93
    builtins = bzrlib.builtins.__dict__
 
94
    for name in builtins:
 
95
        if name.startswith("cmd_"):
 
96
            real_name = _unsquish_command_name(name)
 
97
            r[real_name] = builtins[name]
 
98
    return r
 
99
            
 
100
 
 
101
def builtin_command_names():
 
102
    """Return list of builtin command names."""
 
103
    return _builtin_commands().keys()
 
104
    
 
105
 
 
106
def plugin_command_names():
 
107
    return plugin_cmds.keys()
 
108
 
 
109
 
 
110
def _get_cmd_dict(plugins_override=True):
 
111
    """Return name->class mapping for all commands."""
 
112
    d = _builtin_commands()
 
113
    if plugins_override:
 
114
        d.update(plugin_cmds)
 
115
    return d
 
116
 
 
117
    
 
118
def get_all_cmds(plugins_override=True):
 
119
    """Return canonical name and class for all registered commands."""
 
120
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
121
        yield k,v
 
122
 
 
123
 
 
124
def get_cmd_object(cmd_name, plugins_override=True):
 
125
    """Return the canonical name and command class for a command.
 
126
 
 
127
    plugins_override
 
128
        If true, plugin commands can override builtins.
 
129
    """
 
130
    from bzrlib.externalcommand import ExternalCommand
 
131
 
 
132
    # We want only 'ascii' command names, but the user may have typed
 
133
    # in a Unicode name. In that case, they should just get a
 
134
    # 'command not found' error later.
 
135
    # In the future, we may actually support Unicode command names.
 
136
 
 
137
    # first look up this command under the specified name
 
138
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
139
    try:
 
140
        return cmds[cmd_name]()
 
141
    except KeyError:
 
142
        pass
 
143
 
 
144
    # look for any command which claims this as an alias
 
145
    for real_cmd_name, cmd_class in cmds.iteritems():
 
146
        if cmd_name in cmd_class.aliases:
 
147
            return cmd_class()
 
148
 
 
149
    cmd_obj = ExternalCommand.find_command(cmd_name)
 
150
    if cmd_obj:
 
151
        return cmd_obj
 
152
 
 
153
    raise BzrCommandError('unknown command "%s"' % cmd_name)
 
154
 
 
155
 
 
156
class Command(object):
 
157
    """Base class for commands.
 
158
 
 
159
    Commands are the heart of the command-line bzr interface.
 
160
 
 
161
    The command object mostly handles the mapping of command-line
 
162
    parameters into one or more bzrlib operations, and of the results
 
163
    into textual output.
 
164
 
 
165
    Commands normally don't have any state.  All their arguments are
 
166
    passed in to the run method.  (Subclasses may take a different
 
167
    policy if the behaviour of the instance needs to depend on e.g. a
 
168
    shell plugin and not just its Python class.)
 
169
 
 
170
    The docstring for an actual command should give a single-line
 
171
    summary, then a complete description of the command.  A grammar
 
172
    description will be inserted.
 
173
 
 
174
    aliases
 
175
        Other accepted names for this command.
 
176
 
 
177
    takes_args
 
178
        List of argument forms, marked with whether they are optional,
 
179
        repeated, etc.
 
180
 
 
181
                Examples:
 
182
 
 
183
                ['to_location', 'from_branch?', 'file*']
 
184
 
 
185
                'to_location' is required
 
186
                'from_branch' is optional
 
187
                'file' can be specified 0 or more times
 
188
 
 
189
    takes_options
 
190
        List of options that may be given for this command.  These can
 
191
        be either strings, referring to globally-defined options,
 
192
        or option objects.  Retrieve through options().
 
193
 
 
194
    hidden
 
195
        If true, this command isn't advertised.  This is typically
 
196
        for commands intended for expert users.
 
197
 
 
198
    encoding_type
 
199
        Command objects will get a 'outf' attribute, which has been
 
200
        setup to properly handle encoding of unicode strings.
 
201
        encoding_type determines what will happen when characters cannot
 
202
        be encoded
 
203
            strict - abort if we cannot decode
 
204
            replace - put in a bogus character (typically '?')
 
205
            exact - do not encode sys.stdout
 
206
 
 
207
    """
 
208
    aliases = []
 
209
    takes_args = []
 
210
    takes_options = []
 
211
    encoding_type = 'strict'
 
212
 
 
213
    hidden = False
 
214
    
 
215
    def __init__(self):
 
216
        """Construct an instance of this command."""
 
217
        if self.__doc__ == Command.__doc__:
 
218
            warn("No help message set for %r" % self)
 
219
 
 
220
    def options(self):
 
221
        """Return dict of valid options for this command.
 
222
 
 
223
        Maps from long option name to option object."""
 
224
        r = dict()
 
225
        r['help'] = Option.OPTIONS['help']
 
226
        for o in self.takes_options:
 
227
            if isinstance(o, basestring):
 
228
                o = Option.OPTIONS[o]
 
229
            r[o.name] = o
 
230
        return r
 
231
 
 
232
    def _setup_outf(self):
 
233
        """Return a file linked to stdout, which has proper encoding."""
 
234
        assert self.encoding_type in ['strict', 'exact', 'replace']
 
235
 
 
236
        # Originally I was using self.stdout, but that looks
 
237
        # *way* too much like sys.stdout
 
238
        if self.encoding_type == 'exact':
 
239
            self.outf = sys.stdout
 
240
            return
 
241
 
 
242
        output_encoding = bzrlib.osutils.get_terminal_encoding()
 
243
 
 
244
        # use 'replace' so that we don't abort if trying to write out
 
245
        # in e.g. the default C locale.
 
246
        self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
 
247
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
248
        # it just returns the encoding of the wrapped file, which is completely
 
249
        # bogus. So set the attribute, so we can find the correct encoding later.
 
250
        self.outf.encoding = output_encoding
 
251
 
 
252
    @deprecated_method(zero_eight)
 
253
    def run_argv(self, argv):
 
254
        """Parse command line and run.
 
255
        
 
256
        See run_argv_aliases for the 0.8 and beyond api.
 
257
        """
 
258
        return self.run_argv_aliases(argv)
 
259
 
 
260
    def run_argv_aliases(self, argv, alias_argv=None):
 
261
        """Parse the command line and run with extra aliases in alias_argv."""
 
262
        if argv is None:
 
263
            warn("Passing None for [] is deprecated from bzrlib 0.10", 
 
264
                 DeprecationWarning, stacklevel=2)
 
265
            argv = []
 
266
        args, opts = parse_args(self, argv, alias_argv)
 
267
        if 'help' in opts:  # e.g. bzr add --help
 
268
            from bzrlib.help import help_on_command
 
269
            help_on_command(self.name())
 
270
            return 0
 
271
        # mix arguments and options into one dictionary
 
272
        cmdargs = _match_argform(self.name(), self.takes_args, args)
 
273
        cmdopts = {}
 
274
        for k, v in opts.items():
 
275
            cmdopts[k.replace('-', '_')] = v
 
276
 
 
277
        all_cmd_args = cmdargs.copy()
 
278
        all_cmd_args.update(cmdopts)
 
279
 
 
280
        self._setup_outf()
 
281
 
 
282
        return self.run(**all_cmd_args)
 
283
    
 
284
    def run(self):
 
285
        """Actually run the command.
 
286
 
 
287
        This is invoked with the options and arguments bound to
 
288
        keyword parameters.
 
289
 
 
290
        Return 0 or None if the command was successful, or a non-zero
 
291
        shell error code if not.  It's OK for this method to allow
 
292
        an exception to raise up.
 
293
        """
 
294
        raise NotImplementedError('no implementation of command %r' 
 
295
                                  % self.name())
 
296
 
 
297
    def help(self):
 
298
        """Return help message for this class."""
 
299
        from inspect import getdoc
 
300
        if self.__doc__ is Command.__doc__:
 
301
            return None
 
302
        return getdoc(self)
 
303
 
 
304
    def name(self):
 
305
        return _unsquish_command_name(self.__class__.__name__)
 
306
 
 
307
    def plugin_name(self):
 
308
        """Get the name of the plugin that provides this command.
 
309
 
 
310
        :return: The name of the plugin or None if the command is builtin.
 
311
        """
 
312
        mod_parts = self.__module__.split('.')
 
313
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
314
            return mod_parts[2]
 
315
        else:
 
316
            return None
 
317
 
 
318
 
 
319
def parse_spec(spec):
 
320
    """
 
321
    >>> parse_spec(None)
 
322
    [None, None]
 
323
    >>> parse_spec("./")
 
324
    ['./', None]
 
325
    >>> parse_spec("../@")
 
326
    ['..', -1]
 
327
    >>> parse_spec("../f/@35")
 
328
    ['../f', 35]
 
329
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
 
330
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
 
331
    """
 
332
    if spec is None:
 
333
        return [None, None]
 
334
    if '/@' in spec:
 
335
        parsed = spec.split('/@')
 
336
        assert len(parsed) == 2
 
337
        if parsed[1] == "":
 
338
            parsed[1] = -1
 
339
        else:
 
340
            try:
 
341
                parsed[1] = int(parsed[1])
 
342
            except ValueError:
 
343
                pass # We can allow stuff like ./@revid:blahblahblah
352
344
            else:
353
 
                kindch = '???'
354
 
                
355
 
            print '%-8s %s%s' % (fc, fp, kindch)
356
 
        else:
357
 
            print fp
358
 
    
359
 
    
360
 
 
361
 
def cmd_unknowns():
362
 
    """List unknown files"""
363
 
    for f in Branch('.').unknowns():
364
 
        print quotefn(f)
365
 
 
366
 
 
367
 
def cmd_lookup_revision(revno):
368
 
    try:
369
 
        revno = int(revno)
370
 
    except ValueError:
371
 
        bailout("usage: lookup-revision REVNO",
372
 
                ["REVNO is a non-negative revision number for this branch"])
373
 
 
374
 
    print Branch('.').lookup_revision(revno) or NONE_STRING
375
 
 
376
 
 
377
 
 
378
 
def cmd_export(revno, dest):
379
 
    """Export past revision to destination directory."""
380
 
    b = Branch('.')
381
 
    rh = b.lookup_revision(int(revno))
382
 
    t = b.revision_tree(rh)
383
 
    t.export(dest)
384
 
 
385
 
 
386
 
 
387
 
######################################################################
388
 
# internal/test commands
389
 
 
390
 
 
391
 
def cmd_uuid():
392
 
    """Print a newly-generated UUID."""
393
 
    print uuid()
394
 
 
395
 
 
396
 
 
397
 
def cmd_local_time_offset():
398
 
    print bzrlib.osutils.local_time_offset()
399
 
 
400
 
 
401
 
 
402
 
def cmd_commit(message, verbose=False):
403
 
    Branch('.').commit(message, verbose=verbose)
404
 
 
405
 
 
406
 
def cmd_check():
407
 
    """Check consistency of the branch."""
408
 
    check()
409
 
 
410
 
 
411
 
def cmd_is(pred, *rest):
412
 
    """Test whether PREDICATE is true."""
413
 
    try:
414
 
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
415
 
    except KeyError:
416
 
        bailout("unknown predicate: %s" % quotefn(pred))
417
 
        
418
 
    try:
419
 
        cmd_handler(*rest)
420
 
    except BzrCheckError:
421
 
        # by default we don't print the message so that this can
422
 
        # be used from shell scripts without producing noise
423
 
        sys.exit(1)
424
 
 
425
 
 
426
 
def cmd_username():
427
 
    print bzrlib.osutils.username()
428
 
 
429
 
 
430
 
def cmd_user_email():
431
 
    print bzrlib.osutils.user_email()
432
 
 
433
 
 
434
 
def cmd_gen_revision_id():
435
 
    import time
436
 
    print bzrlib.branch._gen_revision_id(time.time())
437
 
 
438
 
 
439
 
def cmd_doctest():
440
 
    """Run internal doctest suite"""
441
 
    ## -v, if present, is seen by doctest; the argument is just here
442
 
    ## so our parser doesn't complain
443
 
 
444
 
    ## TODO: --verbose option
445
 
    
446
 
    import bzr, doctest, bzrlib.store
447
 
    bzrlib.trace.verbose = False
448
 
    doctest.testmod(bzr)
449
 
    doctest.testmod(bzrlib.store)
450
 
    doctest.testmod(bzrlib.inventory)
451
 
    doctest.testmod(bzrlib.branch)
452
 
    doctest.testmod(bzrlib.osutils)
453
 
    doctest.testmod(bzrlib.tree)
454
 
 
455
 
    # more strenuous tests;
456
 
    import bzrlib.tests
457
 
    doctest.testmod(bzrlib.tests)
458
 
 
459
 
 
460
 
######################################################################
461
 
# help
462
 
 
463
 
 
464
 
def cmd_help():
465
 
    # TODO: Specific help for particular commands
466
 
    print __doc__
467
 
 
468
 
 
469
 
def cmd_version():
470
 
    print "bzr (bazaar-ng) %s" % __version__
471
 
    print __copyright__
472
 
    print "http://bazaar-ng.org/"
473
 
    print
474
 
    print \
475
 
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
476
 
you may use, modify and redistribute it under the terms of the GNU 
477
 
General Public License version 2 or later."""
478
 
 
479
 
 
480
 
def cmd_rocks():
481
 
    """Statement of optimism."""
482
 
    print "it sure does!"
483
 
 
484
 
 
485
 
 
486
 
######################################################################
487
 
# main routine
488
 
 
489
 
 
490
 
# list of all available options; the rhs can be either None for an
491
 
# option that takes no argument, or a constructor function that checks
492
 
# the type.
493
 
OPTIONS = {
494
 
    'all':                    None,
495
 
    'help':                   None,
496
 
    'message':                unicode,
497
 
    'revision':               int,
498
 
    'show-ids':               None,
499
 
    'timezone':               str,
500
 
    'verbose':                None,
501
 
    'version':                None,
502
 
    }
503
 
 
504
 
SHORT_OPTIONS = {
505
 
    'm':                      'message',
506
 
    'r':                      'revision',
507
 
    'v':                      'verbose',
508
 
}
509
 
 
510
 
# List of options that apply to particular commands; commands not
511
 
# listed take none.
512
 
cmd_options = {
513
 
    'add':                    ['verbose'],
514
 
    'commit':                 ['message', 'verbose'],
515
 
    'diff':                   ['revision'],
516
 
    'inventory':              ['revision'],
517
 
    'log':                    ['show-ids', 'timezone'],
518
 
    'ls':                     ['revision', 'verbose'],
519
 
    'remove':                 ['verbose'],
520
 
    'status':                 ['all'],
521
 
    }
522
 
 
523
 
 
524
 
cmd_args = {
525
 
    'init':                   [],
526
 
    'add':                    ['file+'],
527
 
    'commit':                 [],
528
 
    'diff':                   [],
529
 
    'file-id':                ['filename'],
530
 
    'get-file-text':          ['text_id'],
531
 
    'get-inventory':          ['inventory_id'],
532
 
    'get-revision':           ['revision_id'],
533
 
    'get-revision-inventory': ['revision_id'],
534
 
    'log':                    [],
535
 
    'lookup-revision':        ['revno'],
536
 
    'export':                 ['revno', 'dest'],
537
 
    'remove':                 ['file+'],
538
 
    'status':                 [],
539
 
    }
540
 
 
541
 
 
542
 
def parse_args(argv):
 
345
                assert parsed[1] >=0
 
346
    else:
 
347
        parsed = [spec, None]
 
348
    return parsed
 
349
 
 
350
def parse_args(command, argv, alias_argv=None):
543
351
    """Parse command line.
544
352
    
545
353
    Arguments and options are parsed at this level before being passed
546
354
    down to specific command handlers.  This routine knows, from a
547
355
    lookup table, something about the available options, what optargs
548
356
    they take, and which commands will accept them.
549
 
 
550
 
    >>> parse_args('bzr --help'.split())
551
 
    ([], {'help': True})
552
 
    >>> parse_args('bzr --version'.split())
553
 
    ([], {'version': True})
554
 
    >>> parse_args('bzr status --all'.split())
555
 
    (['status'], {'all': True})
556
357
    """
557
 
    args = []
558
 
    opts = {}
559
 
 
560
 
    # TODO: Maybe handle '--' to end options?
561
 
 
562
 
    it = iter(argv[1:])
563
 
    while it:
564
 
        a = it.next()
565
 
        if a[0] == '-':
566
 
            if a[1] == '-':
567
 
                mutter("  got option %r" % a)
568
 
                optname = a[2:]
569
 
                if optname not in OPTIONS:
570
 
                    bailout('unknown long option %r' % a)
571
 
            else:
572
 
                shortopt = a[1:]
573
 
                if shortopt not in SHORT_OPTIONS:
574
 
                    bailout('unknown short option %r' % a)
575
 
                optname = SHORT_OPTIONS[shortopt]
576
 
            
577
 
            if optname in opts:
578
 
                # XXX: Do we ever want to support this, e.g. for -r?
579
 
                bailout('repeated option %r' % a)
580
 
            optargfn = OPTIONS[optname]
581
 
            if optargfn:
582
 
                if not it:
583
 
                    bailout('option %r needs an argument' % a)
584
 
                opts[optname] = optargfn(it.next())
585
 
                mutter("    option argument %r" % opts[optname])
586
 
            else:
587
 
                # takes no option argument
588
 
                opts[optname] = True
589
 
        elif a[:1] == '-':
590
 
            bailout('unknown short option %r' % a)
591
 
        else:
592
 
            args.append(a)
593
 
 
 
358
    # TODO: make it a method of the Command?
 
359
    parser = option.get_optparser(command.options())
 
360
    if alias_argv is not None:
 
361
        args = alias_argv + argv
 
362
    else:
 
363
        args = argv
 
364
 
 
365
    options, args = parser.parse_args(args)
 
366
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if 
 
367
                 v is not option.OptionParser.DEFAULT_VALUE])
594
368
    return args, opts
595
369
 
596
370
 
597
 
 
598
 
def _match_args(cmd, args):
599
 
    """Check non-option arguments match required pattern.
600
 
 
601
 
    >>> _match_args('status', ['asdasdsadasd'])
602
 
    Traceback (most recent call last):
603
 
    ...
604
 
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
605
 
    >>> _match_args('add', ['asdasdsadasd'])
606
 
    {'file_list': ['asdasdsadasd']}
607
 
    >>> _match_args('add', 'abc def gj'.split())
608
 
    {'file_list': ['abc', 'def', 'gj']}
609
 
    """
610
 
    # match argument pattern
611
 
    argform = cmd_args.get(cmd, [])
 
371
def _match_argform(cmd, takes_args, args):
612
372
    argdict = {}
613
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
614
 
    # all but one.
615
 
    for ap in argform:
 
373
 
 
374
    # step through args and takes_args, allowing appropriate 0-many matches
 
375
    for ap in takes_args:
616
376
        argname = ap[:-1]
617
377
        if ap[-1] == '?':
618
 
            assert 0
619
 
        elif ap[-1] == '*':
620
 
            assert 0
 
378
            if args:
 
379
                argdict[argname] = args.pop(0)
 
380
        elif ap[-1] == '*': # all remaining arguments
 
381
            if args:
 
382
                argdict[argname + '_list'] = args[:]
 
383
                args = []
 
384
            else:
 
385
                argdict[argname + '_list'] = None
621
386
        elif ap[-1] == '+':
622
387
            if not args:
623
 
                bailout("command %r needs one or more %s"
 
388
                raise BzrCommandError("command %r needs one or more %s"
624
389
                        % (cmd, argname.upper()))
625
390
            else:
626
391
                argdict[argname + '_list'] = args[:]
627
392
                args = []
 
393
        elif ap[-1] == '$': # all but one
 
394
            if len(args) < 2:
 
395
                raise BzrCommandError("command %r needs one or more %s"
 
396
                        % (cmd, argname.upper()))
 
397
            argdict[argname + '_list'] = args[:-1]
 
398
            args[:-1] = []
628
399
        else:
629
400
            # just a plain arg
630
401
            argname = ap
631
402
            if not args:
632
 
                bailout("command %r requires argument %s"
 
403
                raise BzrCommandError("command %r requires argument %s"
633
404
                        % (cmd, argname.upper()))
634
405
            else:
635
406
                argdict[argname] = args.pop(0)
636
407
            
637
408
    if args:
638
 
        bailout("extra arguments to command %s: %r"
639
 
                % (cmd, args))
 
409
        raise BzrCommandError("extra argument to command %s: %s"
 
410
                              % (cmd, args[0]))
640
411
 
641
412
    return argdict
642
413
 
643
414
 
644
415
 
 
416
def apply_profiled(the_callable, *args, **kwargs):
 
417
    import hotshot
 
418
    import tempfile
 
419
    import hotshot.stats
 
420
    pffileno, pfname = tempfile.mkstemp()
 
421
    try:
 
422
        prof = hotshot.Profile(pfname)
 
423
        try:
 
424
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
425
        finally:
 
426
            prof.close()
 
427
        stats = hotshot.stats.load(pfname)
 
428
        stats.strip_dirs()
 
429
        stats.sort_stats('cum')   # 'time'
 
430
        ## XXX: Might like to write to stderr or the trace file instead but
 
431
        ## print_stats seems hardcoded to stdout
 
432
        stats.print_stats(20)
 
433
        return ret
 
434
    finally:
 
435
        os.close(pffileno)
 
436
        os.remove(pfname)
 
437
 
 
438
 
 
439
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
 
440
    from bzrlib.lsprof import profile
 
441
    import cPickle
 
442
    ret, stats = profile(the_callable, *args, **kwargs)
 
443
    stats.sort()
 
444
    if filename is None:
 
445
        stats.pprint()
 
446
    else:
 
447
        stats.freeze()
 
448
        cPickle.dump(stats, open(filename, 'w'), 2)
 
449
        print 'Profile data written to %r.' % filename
 
450
    return ret
 
451
 
 
452
 
 
453
def get_alias(cmd):
 
454
    """Return an expanded alias, or None if no alias exists"""
 
455
    import bzrlib.config
 
456
    alias = bzrlib.config.GlobalConfig().get_alias(cmd)
 
457
    if (alias):
 
458
        return alias.split(' ')
 
459
    return None
 
460
 
 
461
 
645
462
def run_bzr(argv):
646
463
    """Execute a command.
647
464
 
648
465
    This is similar to main(), but without all the trappings for
649
 
    logging and error handling.
 
466
    logging and error handling.  
 
467
    
 
468
    argv
 
469
       The command-line arguments, without the program name from argv[0]
 
470
       These should already be decoded. All library/test code calling
 
471
       run_bzr should be passing valid strings (don't need decoding).
 
472
    
 
473
    Returns a command status or raises an exception.
 
474
 
 
475
    Special master options: these must come before the command because
 
476
    they control how the command is interpreted.
 
477
 
 
478
    --no-plugins
 
479
        Do not load plugin modules at all
 
480
 
 
481
    --no-aliases
 
482
        Do not allow aliases
 
483
 
 
484
    --builtin
 
485
        Only use builtin commands.  (Plugins are still allowed to change
 
486
        other behaviour.)
 
487
 
 
488
    --profile
 
489
        Run under the Python hotshot profiler.
 
490
 
 
491
    --lsprof
 
492
        Run under the Python lsprof profiler.
650
493
    """
651
 
    try:
652
 
        args, opts = parse_args(argv)
653
 
        if 'help' in opts:
654
 
            # TODO: pass down other arguments in case they asked for
655
 
            # help on a command name?
656
 
            cmd_help()
657
 
            return 0
658
 
        elif 'version' in opts:
659
 
            cmd_version()
660
 
            return 0
661
 
        cmd = args.pop(0)
662
 
    except IndexError:
663
 
        log_error('usage: bzr COMMAND\n')
664
 
        log_error('  try "bzr help"\n')
665
 
        return 1
666
 
            
667
 
    try:
668
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
669
 
    except KeyError:
670
 
        bailout("unknown command " + `cmd`)
671
 
 
672
 
    # TODO: special --profile option to turn on the Python profiler
673
 
 
674
 
    # check options are reasonable
675
 
    allowed = cmd_options.get(cmd, [])
676
 
    for oname in opts:
677
 
        if oname not in allowed:
678
 
            bailout("option %r is not allowed for command %r"
679
 
                    % (oname, cmd))
680
 
 
681
 
    cmdargs = _match_args(cmd, args)
682
 
    cmdargs.update(opts)
683
 
 
684
 
    ret = cmd_handler(**cmdargs) or 0
685
 
 
 
494
    argv = list(argv)
 
495
 
 
496
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
497
                opt_no_aliases = False
 
498
    opt_lsprof_file = None
 
499
 
 
500
    # --no-plugins is handled specially at a very early stage. We need
 
501
    # to load plugins before doing other command parsing so that they
 
502
    # can override commands, but this needs to happen first.
 
503
 
 
504
    argv_copy = []
 
505
    i = 0
 
506
    while i < len(argv):
 
507
        a = argv[i]
 
508
        if a == '--profile':
 
509
            opt_profile = True
 
510
        elif a == '--lsprof':
 
511
            opt_lsprof = True
 
512
        elif a == '--lsprof-file':
 
513
            opt_lsprof = True
 
514
            opt_lsprof_file = argv[i + 1]
 
515
            i += 1
 
516
        elif a == '--no-plugins':
 
517
            opt_no_plugins = True
 
518
        elif a == '--no-aliases':
 
519
            opt_no_aliases = True
 
520
        elif a == '--builtin':
 
521
            opt_builtin = True
 
522
        elif a in ('--quiet', '-q'):
 
523
            be_quiet()
 
524
        else:
 
525
            argv_copy.append(a)
 
526
        i += 1
 
527
 
 
528
    argv = argv_copy
 
529
    if (not argv):
 
530
        from bzrlib.builtins import cmd_help
 
531
        cmd_help().run_argv_aliases([])
 
532
        return 0
 
533
 
 
534
    if argv[0] == '--version':
 
535
        from bzrlib.version import show_version
 
536
        show_version()
 
537
        return 0
 
538
        
 
539
    if not opt_no_plugins:
 
540
        from bzrlib.plugin import load_plugins
 
541
        load_plugins()
 
542
    else:
 
543
        from bzrlib.plugin import disable_plugins
 
544
        disable_plugins()
 
545
 
 
546
    alias_argv = None
 
547
 
 
548
    if not opt_no_aliases:
 
549
        alias_argv = get_alias(argv[0])
 
550
        if alias_argv:
 
551
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
 
552
            argv[0] = alias_argv.pop(0)
 
553
 
 
554
    cmd = argv.pop(0)
 
555
    # We want only 'ascii' command names, but the user may have typed
 
556
    # in a Unicode name. In that case, they should just get a
 
557
    # 'command not found' error later.
 
558
 
 
559
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
 
560
    if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
 
561
        run = cmd_obj.run_argv
 
562
        run_argv = [argv]
 
563
    else:
 
564
        run = cmd_obj.run_argv_aliases
 
565
        run_argv = [argv, alias_argv]
 
566
 
 
567
    try:
 
568
        if opt_lsprof:
 
569
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
 
570
        elif opt_profile:
 
571
            ret = apply_profiled(run, *run_argv)
 
572
        else:
 
573
            ret = run(*run_argv)
 
574
        return ret or 0
 
575
    finally:
 
576
        # reset, in case we may do other commands later within the same process
 
577
        be_quiet(False)
 
578
 
 
579
def display_command(func):
 
580
    """Decorator that suppresses pipe/interrupt errors."""
 
581
    def ignore_pipe(*args, **kwargs):
 
582
        try:
 
583
            result = func(*args, **kwargs)
 
584
            sys.stdout.flush()
 
585
            return result
 
586
        except IOError, e:
 
587
            if getattr(e, 'errno', None) is None:
 
588
                raise
 
589
            if e.errno != errno.EPIPE:
 
590
                # Win32 raises IOError with errno=0 on a broken pipe
 
591
                if sys.platform != 'win32' or e.errno != 0:
 
592
                    raise
 
593
            pass
 
594
        except KeyboardInterrupt:
 
595
            pass
 
596
    return ignore_pipe
686
597
 
687
598
 
688
599
def main(argv):
689
 
    ## TODO: Handle command-line options; probably know what options are valid for
690
 
    ## each command
691
 
 
692
 
    ## TODO: If the arguments are wrong, give a usage message rather
693
 
    ## than just a backtrace.
694
 
 
 
600
    import bzrlib.ui
 
601
    from bzrlib.ui.text import TextUIFactory
 
602
    bzrlib.ui.ui_factory = TextUIFactory()
 
603
    argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
 
604
    ret = run_bzr_catch_errors(argv)
 
605
    mutter("return code %d", ret)
 
606
    return ret
 
607
 
 
608
 
 
609
def run_bzr_catch_errors(argv):
695
610
    try:
696
 
        t = bzrlib.trace._tracefile
697
 
        t.write('-' * 60 + '\n')
698
 
        t.write('bzr invoked at %s\n' % format_date(time.time()))
699
 
        t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
700
 
        t.write('  arguments: %r\n' % argv)
701
 
 
702
 
        starttime = os.times()[4]
703
 
 
704
 
        import platform
705
 
        t.write('  platform: %s\n' % platform.platform())
706
 
        t.write('  python: %s\n' % platform.python_version())
707
 
 
708
 
        ret = run_bzr(argv)
709
 
        
710
 
        times = os.times()
711
 
        mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
712
 
               % times[:4])
713
 
        mutter("    %.3f elapsed" % (times[4] - starttime))
714
 
 
715
 
        return ret
716
 
    except BzrError, e:
717
 
        log_error('bzr: error: ' + e.args[0] + '\n')
718
 
        if len(e.args) > 1:
719
 
            for h in e.args[1]:
720
 
                log_error('  ' + h + '\n')
721
 
        return 1
722
 
    except Exception, e:
723
 
        log_error('bzr: exception: %s\n' % e)
724
 
        log_error('    see .bzr.log for details\n')
725
 
        traceback.print_exc(None, bzrlib.trace._tracefile)
726
 
        traceback.print_exc(None, sys.stderr)
727
 
        return 1
728
 
 
729
 
    # TODO: Maybe nicer handling of IOError?
730
 
 
731
 
 
 
611
        return run_bzr(argv)
 
612
        # do this here inside the exception wrappers to catch EPIPE
 
613
        sys.stdout.flush()
 
614
    except (KeyboardInterrupt, Exception), e:
 
615
        # used to handle AssertionError and KeyboardInterrupt
 
616
        # specially here, but hopefully they're handled ok by the logger now
 
617
        bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
 
618
        if os.environ.get('BZR_PDB'):
 
619
            print '**** entering debugger'
 
620
            import pdb
 
621
            pdb.post_mortem(sys.exc_traceback)
 
622
        return 3
732
623
 
733
624
if __name__ == '__main__':
734
625
    sys.exit(main(sys.argv))
735
 
    ##import profile
736
 
    ##profile.run('main(sys.argv)')
737