~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:14:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021435-87fa19f051842647
- new helper function kind_marker()

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Martin Pool
2
 
# Copyright (C) 2005 by Canonical Ltd
3
 
 
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
4
2
 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
 
"""Bazaar-NG -- a free distributed version-control tool
20
 
 
21
 
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
 
 
23
 
Current limitation include:
24
 
 
25
 
* Metadata format is not stable yet -- you may need to
26
 
  discard history in the future.
27
 
 
28
 
* Insufficient error handling.
29
 
 
30
 
* Many commands unimplemented or partially implemented.
31
 
 
32
 
* Space-inefficient storage.
33
 
 
34
 
* No merge operators yet.
35
 
 
36
 
Interesting commands::
37
 
 
38
 
  bzr help [COMMAND]
39
 
       Show help screen
40
 
  bzr version
41
 
       Show software version/licence/non-warranty.
42
 
  bzr init
43
 
       Start versioning the current directory
44
 
  bzr add FILE...
45
 
       Make files versioned.
46
 
  bzr log
47
 
       Show revision history.
48
 
  bzr diff
49
 
       Show changes from last revision to working copy.
50
 
  bzr commit -m 'MESSAGE'
51
 
       Store current state as new revision.
52
 
  bzr export REVNO DESTINATION
53
 
       Export the branch state at a previous version.
54
 
  bzr status
55
 
       Show summary of pending changes.
56
 
  bzr remove FILE...
57
 
       Make a file not versioned.
58
 
  bzr info
59
 
       Show statistics about this branch.
60
 
"""
61
 
 
62
 
 
63
 
 
64
 
 
65
 
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
 
import traceback, socket, fnmatch, difflib
67
 
from os import path
 
17
 
 
18
 
 
19
import sys, os, time, os.path
68
20
from sets import Set
69
 
from pprint import pprint
70
 
from stat import *
71
 
from glob import glob
72
21
 
73
22
import bzrlib
74
 
from bzrlib.store import ImmutableStore
75
23
from bzrlib.trace import mutter, note, log_error
76
 
from bzrlib.errors import bailout, BzrError
 
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
77
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
 
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
79
27
from bzrlib.revision import Revision
80
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
29
     format_date
82
30
 
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):
 
31
 
 
32
def _squish_command_name(cmd):
 
33
    return 'cmd_' + cmd.replace('-', '_')
 
34
 
 
35
 
 
36
def _unsquish_command_name(cmd):
 
37
    assert cmd.startswith("cmd_")
 
38
    return cmd[4:].replace('_','-')
 
39
 
 
40
def get_all_cmds():
 
41
    """Return canonical name and class for all registered commands."""
 
42
    for k, v in globals().iteritems():
 
43
        if k.startswith("cmd_"):
 
44
            yield _unsquish_command_name(k), v
 
45
 
 
46
def get_cmd_class(cmd):
 
47
    """Return the canonical name and command class for a command.
 
48
    """
 
49
    cmd = str(cmd)                      # not unicode
 
50
 
 
51
    # first look up this command under the specified name
 
52
    try:
 
53
        return cmd, globals()[_squish_command_name(cmd)]
 
54
    except KeyError:
 
55
        pass
 
56
 
 
57
    # look for any command which claims this as an alias
 
58
    for cmdname, cmdclass in get_all_cmds():
 
59
        if cmd in cmdclass.aliases:
 
60
            return cmdname, cmdclass
 
61
 
 
62
    cmdclass = ExternalCommand.find_command(cmd)
 
63
    if cmdclass:
 
64
        return cmd, cmdclass
 
65
 
 
66
    raise BzrCommandError("unknown command %r" % cmd)
 
67
 
 
68
 
 
69
class Command:
 
70
    """Base class for commands.
 
71
 
 
72
    The docstring for an actual command should give a single-line
 
73
    summary, then a complete description of the command.  A grammar
 
74
    description will be inserted.
 
75
 
 
76
    takes_args
 
77
        List of argument forms, marked with whether they are optional,
 
78
        repeated, etc.
 
79
 
 
80
    takes_options
 
81
        List of options that may be given for this command.
 
82
 
 
83
    hidden
 
84
        If true, this command isn't advertised.
 
85
    """
 
86
    aliases = []
 
87
    
 
88
    takes_args = []
 
89
    takes_options = []
 
90
 
 
91
    hidden = False
 
92
    
 
93
    def __init__(self, options, arguments):
 
94
        """Construct and run the command.
 
95
 
 
96
        Sets self.status to the return value of run()."""
 
97
        assert isinstance(options, dict)
 
98
        assert isinstance(arguments, dict)
 
99
        cmdargs = options.copy()
 
100
        cmdargs.update(arguments)
 
101
        assert self.__doc__ != Command.__doc__, \
 
102
               ("No help message set for %r" % self)
 
103
        self.status = self.run(**cmdargs)
 
104
 
 
105
    
 
106
    def run(self):
 
107
        """Override this in sub-classes.
 
108
 
 
109
        This is invoked with the options and arguments bound to
 
110
        keyword parameters.
 
111
 
 
112
        Return 0 or None if the command was successful, or a shell
 
113
        error code if not.
 
114
        """
 
115
        return 0
 
116
 
 
117
 
 
118
class ExternalCommand(Command):
 
119
    """Class to wrap external commands.
 
120
 
 
121
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
122
    an object we construct that has the appropriate path, help, options etc for the
 
123
    specified command.
 
124
 
 
125
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
126
    method, which we override to call the Command.__init__ method. That then calls
 
127
    our run method which is pretty straight forward.
 
128
 
 
129
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
130
    back into command line options and arguments for the script.
 
131
    """
 
132
 
 
133
    def find_command(cls, cmd):
 
134
        bzrpath = os.environ.get('BZRPATH', '')
 
135
 
 
136
        for dir in bzrpath.split(':'):
 
137
            path = os.path.join(dir, cmd)
 
138
            if os.path.isfile(path):
 
139
                return ExternalCommand(path)
 
140
 
 
141
        return None
 
142
 
 
143
    find_command = classmethod(find_command)
 
144
 
 
145
    def __init__(self, path):
 
146
        self.path = path
 
147
 
 
148
        # TODO: If either of these fail, we should detect that and
 
149
        # assume that path is not really a bzr plugin after all.
 
150
 
 
151
        pipe = os.popen('%s --bzr-usage' % path, 'r')
 
152
        self.takes_options = pipe.readline().split()
 
153
        self.takes_args = pipe.readline().split()
 
154
        pipe.close()
 
155
 
 
156
        pipe = os.popen('%s --bzr-help' % path, 'r')
 
157
        self.__doc__ = pipe.read()
 
158
        pipe.close()
 
159
 
 
160
    def __call__(self, options, arguments):
 
161
        Command.__init__(self, options, arguments)
 
162
        return self
 
163
 
 
164
    def run(self, **kargs):
 
165
        opts = []
 
166
        args = []
 
167
 
 
168
        keys = kargs.keys()
 
169
        keys.sort()
 
170
        for name in keys:
 
171
            value = kargs[name]
 
172
            if OPTIONS.has_key(name):
 
173
                # it's an option
 
174
                opts.append('--%s' % name)
 
175
                if value is not None and value is not True:
 
176
                    opts.append(str(value))
 
177
            else:
 
178
                # it's an arg, or arg list
 
179
                if type(value) is not list:
 
180
                    value = [value]
 
181
                for v in value:
 
182
                    if v is not None:
 
183
                        args.append(str(v))
 
184
 
 
185
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
 
186
        return self.status
 
187
 
 
188
 
 
189
class cmd_status(Command):
122
190
    """Display status summary.
123
191
 
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?
 
192
    This reports on versioned and unknown files, reporting them
 
193
    grouped by state.  Possible states are:
 
194
 
 
195
    added
 
196
        Versioned in the working copy but not in the previous revision.
 
197
 
 
198
    removed
 
199
        Versioned in the previous revision but removed or deleted
 
200
        in the working copy.
 
201
 
 
202
    renamed
 
203
        Path of this file changed from the previous revision;
 
204
        the text may also have changed.  This includes files whose
 
205
        parent directory was renamed.
 
206
 
 
207
    modified
 
208
        Text has changed since the previous revision.
 
209
 
 
210
    unchanged
 
211
        Nothing about this file has changed since the previous revision.
 
212
        Only shown with --all.
 
213
 
 
214
    unknown
 
215
        Not versioned and not matching an ignore pattern.
 
216
 
 
217
    To see ignored files use 'bzr ignored'.  For details in the
 
218
    changes to file texts, use 'bzr diff'.
 
219
 
 
220
    If no arguments are specified, the status of the entire working
 
221
    directory is shown.  Otherwise, only the status of the specified
 
222
    files or directories is reported.  If a directory is given, status
 
223
    is reported for everything inside that directory.
129
224
    """
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):
 
225
    takes_args = ['file*']
 
226
    takes_options = ['all', 'show-ids']
 
227
    aliases = ['st', 'stat']
 
228
    
 
229
    def run(self, all=False, show_ids=False, file_list=None):
 
230
        if file_list:
 
231
            b = Branch(file_list[0], lock_mode='r')
 
232
            file_list = [b.relpath(x) for x in file_list]
 
233
            # special case: only one path was given and it's the root
 
234
            # of the branch
 
235
            if file_list == ['']:
 
236
                file_list = None
 
237
        else:
 
238
            b = Branch('.', lock_mode='r')
 
239
        import status
 
240
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
241
                           specific_files=file_list)
 
242
 
 
243
 
 
244
class cmd_cat_revision(Command):
 
245
    """Write out metadata for a revision."""
 
246
 
 
247
    hidden = True
 
248
    takes_args = ['revision_id']
 
249
    
 
250
    def run(self, revision_id):
 
251
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
252
 
 
253
 
 
254
class cmd_revno(Command):
 
255
    """Show current revision number.
 
256
 
 
257
    This is equal to the number of revisions on this branch."""
 
258
    def run(self):
 
259
        print Branch('.').revno()
 
260
 
 
261
    
 
262
class cmd_add(Command):
158
263
    """Add specified files or directories.
159
264
 
160
265
    In non-recursive mode, all the named items are added, regardless
171
276
 
172
277
    Therefore simply saying 'bzr add .' will version all files that
173
278
    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):
 
279
 
 
280
    TODO: Perhaps adding a file whose directly is not versioned should
 
281
    recursively add that parent, rather than giving an error?
 
282
    """
 
283
    takes_args = ['file+']
 
284
    takes_options = ['verbose']
 
285
    
 
286
    def run(self, file_list, verbose=False):
 
287
        bzrlib.add.smart_add(file_list, verbose)
 
288
 
 
289
 
 
290
class cmd_relpath(Command):
 
291
    """Show path of a file relative to root"""
 
292
    takes_args = ['filename']
 
293
    
 
294
    def run(self, filename):
 
295
        print Branch(filename).relpath(filename)
 
296
 
 
297
 
 
298
 
 
299
class cmd_inventory(Command):
 
300
    """Show inventory of the current working copy or a revision."""
 
301
    takes_options = ['revision']
 
302
    
 
303
    def run(self, revision=None):
 
304
        b = Branch('.')
 
305
        if revision == None:
 
306
            inv = b.read_working_inventory()
 
307
        else:
 
308
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
309
 
 
310
        for path, entry in inv.iter_entries():
 
311
            print '%-50s %s' % (entry.file_id, path)
 
312
 
 
313
 
 
314
class cmd_move(Command):
 
315
    """Move files to a different directory.
 
316
 
 
317
    examples:
 
318
        bzr move *.txt doc
 
319
 
 
320
    The destination must be a versioned directory in the same branch.
 
321
    """
 
322
    takes_args = ['source$', 'dest']
 
323
    def run(self, source_list, dest):
 
324
        b = Branch('.')
 
325
 
 
326
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
327
 
 
328
 
 
329
class cmd_rename(Command):
 
330
    """Change the name of an entry.
 
331
 
 
332
    examples:
 
333
      bzr rename frob.c frobber.c
 
334
      bzr rename src/frob.c lib/frob.c
 
335
 
 
336
    It is an error if the destination name exists.
 
337
 
 
338
    See also the 'move' command, which moves files into a different
 
339
    directory without changing their name.
 
340
 
 
341
    TODO: Some way to rename multiple files without invoking bzr for each
 
342
    one?"""
 
343
    takes_args = ['from_name', 'to_name']
 
344
    
 
345
    def run(self, from_name, to_name):
 
346
        b = Branch('.')
 
347
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
348
 
 
349
 
 
350
 
 
351
class cmd_renames(Command):
 
352
    """Show list of renamed files.
 
353
 
 
354
    TODO: Option to show renames between two historical versions.
 
355
 
 
356
    TODO: Only show renames under dir, rather than in the whole branch.
 
357
    """
 
358
    takes_args = ['dir?']
 
359
 
 
360
    def run(self, dir='.'):
 
361
        b = Branch(dir)
 
362
        old_inv = b.basis_tree().inventory
 
363
        new_inv = b.read_working_inventory()
 
364
 
 
365
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
366
        renames.sort()
 
367
        for old_name, new_name in renames:
 
368
            print "%s => %s" % (old_name, new_name)        
 
369
 
 
370
 
 
371
class cmd_info(Command):
 
372
    """Show statistical information about a branch."""
 
373
    takes_args = ['branch?']
 
374
    
 
375
    def run(self, branch=None):
 
376
        import info
 
377
 
 
378
        from branch import find_branch
 
379
        b = find_branch(branch)
 
380
        info.show_info(b)
 
381
 
 
382
 
 
383
class cmd_remove(Command):
 
384
    """Make a file unversioned.
 
385
 
 
386
    This makes bzr stop tracking changes to a versioned file.  It does
 
387
    not delete the working copy.
 
388
    """
 
389
    takes_args = ['file+']
 
390
    takes_options = ['verbose']
 
391
    
 
392
    def run(self, file_list, verbose=False):
 
393
        b = Branch(file_list[0])
 
394
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
395
 
 
396
 
 
397
class cmd_file_id(Command):
 
398
    """Print file_id of a particular file or directory.
 
399
 
 
400
    The file_id is assigned when the file is first added and remains the
 
401
    same through all revisions where the file exists, even when it is
 
402
    moved or renamed.
 
403
    """
 
404
    hidden = True
 
405
    takes_args = ['filename']
 
406
    def run(self, filename):
 
407
        b = Branch(filename)
 
408
        i = b.inventory.path2id(b.relpath(filename))
 
409
        if i == None:
 
410
            bailout("%r is not a versioned file" % filename)
 
411
        else:
 
412
            print i
 
413
 
 
414
 
 
415
class cmd_file_path(Command):
 
416
    """Print path of file_ids to a file or directory.
 
417
 
 
418
    This prints one line for each directory down to the target,
 
419
    starting at the branch root."""
 
420
    hidden = True
 
421
    takes_args = ['filename']
 
422
    def run(self, filename):
 
423
        b = Branch(filename)
 
424
        inv = b.inventory
 
425
        fid = inv.path2id(b.relpath(filename))
 
426
        if fid == None:
 
427
            bailout("%r is not a versioned file" % filename)
 
428
        for fip in inv.get_idpath(fid):
 
429
            print fip
 
430
 
 
431
 
 
432
class cmd_revision_history(Command):
 
433
    """Display list of revision ids on this branch."""
 
434
    def run(self):
 
435
        for patchid in Branch('.').revision_history():
 
436
            print patchid
 
437
 
 
438
 
 
439
class cmd_directories(Command):
 
440
    """Display list of versioned directories in this branch."""
 
441
    def run(self):
 
442
        for name, ie in Branch('.').read_working_inventory().directories():
 
443
            if name == '':
 
444
                print '.'
 
445
            else:
 
446
                print name
 
447
 
 
448
 
 
449
class cmd_init(Command):
 
450
    """Make a directory into a versioned branch.
 
451
 
 
452
    Use this to create an empty branch, or before importing an
 
453
    existing project.
 
454
 
 
455
    Recipe for importing a tree of files:
 
456
        cd ~/project
 
457
        bzr init
 
458
        bzr add -v .
 
459
        bzr status
 
460
        bzr commit -m 'imported project'
 
461
    """
 
462
    def run(self):
 
463
        Branch('.', init=True)
 
464
 
 
465
 
 
466
class cmd_diff(Command):
 
467
    """Show differences in working tree.
 
468
    
 
469
    If files are listed, only the changes in those files are listed.
 
470
    Otherwise, all changes for the tree are listed.
 
471
 
 
472
    TODO: Given two revision arguments, show the difference between them.
 
473
 
 
474
    TODO: Allow diff across branches.
 
475
 
 
476
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
477
          or a graphical diff.
 
478
 
 
479
    TODO: Python difflib is not exactly the same as unidiff; should
 
480
          either fix it up or prefer to use an external diff.
 
481
 
 
482
    TODO: If a directory is given, diff everything under that.
 
483
 
 
484
    TODO: Selected-file diff is inefficient and doesn't show you
 
485
          deleted files.
 
486
 
 
487
    TODO: This probably handles non-Unix newlines poorly.
 
488
    """
 
489
    
 
490
    takes_args = ['file*']
 
491
    takes_options = ['revision']
 
492
    aliases = ['di']
 
493
 
 
494
    def run(self, revision=None, file_list=None):
 
495
        from bzrlib.diff import show_diff
 
496
    
 
497
        show_diff(Branch('.'), revision, specific_files=file_list)
 
498
 
 
499
 
 
500
        
 
501
 
 
502
 
 
503
class cmd_deleted(Command):
343
504
    """List files deleted in the working tree.
344
505
 
345
 
TODO: Show files deleted since a previous revision, or between two revisions.
 
506
    TODO: Show files deleted since a previous revision, or between two revisions.
346
507
    """
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:
 
508
    def run(self, show_ids=False):
 
509
        b = Branch('.')
 
510
        old = b.basis_tree()
 
511
        new = b.working_tree()
 
512
 
 
513
        ## TODO: Much more efficient way to do this: read in new
 
514
        ## directories with readdir, rather than stating each one.  Same
 
515
        ## level of effort but possibly much less IO.  (Or possibly not,
 
516
        ## if the directories are very large...)
 
517
 
 
518
        for path, ie in old.inventory.iter_entries():
 
519
            if not new.has_id(ie.file_id):
 
520
                if show_ids:
 
521
                    print '%-50s %s' % (path, ie.file_id)
 
522
                else:
 
523
                    print path
 
524
 
 
525
 
 
526
class cmd_modified(Command):
 
527
    """List files modified in working tree."""
 
528
    hidden = True
 
529
    def run(self):
 
530
        import statcache
 
531
        b = Branch('.')
 
532
        inv = b.read_working_inventory()
 
533
        sc = statcache.update_cache(b, inv)
 
534
        basis = b.basis_tree()
 
535
        basis_inv = basis.inventory
 
536
        
 
537
        # We used to do this through iter_entries(), but that's slow
 
538
        # when most of the files are unmodified, as is usually the
 
539
        # case.  So instead we iterate by inventory entry, and only
 
540
        # calculate paths as necessary.
 
541
 
 
542
        for file_id in basis_inv:
 
543
            cacheentry = sc.get(file_id)
 
544
            if not cacheentry:                 # deleted
 
545
                continue
 
546
            ie = basis_inv[file_id]
 
547
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
548
                path = inv.id2path(file_id)
356
549
                print path
 
550
 
 
551
 
 
552
 
 
553
class cmd_added(Command):
 
554
    """List files added in working tree."""
 
555
    hidden = True
 
556
    def run(self):
 
557
        b = Branch('.')
 
558
        wt = b.working_tree()
 
559
        basis_inv = b.basis_tree().inventory
 
560
        inv = wt.inventory
 
561
        for file_id in inv:
 
562
            if file_id in basis_inv:
 
563
                continue
 
564
            path = inv.id2path(file_id)
 
565
            if not os.access(b.abspath(path), os.F_OK):
 
566
                continue
 
567
            print path
357
568
                
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'):
 
569
        
 
570
 
 
571
class cmd_root(Command):
 
572
    """Show the tree root directory.
 
573
 
 
574
    The root is the nearest enclosing directory with a .bzr control
 
575
    directory."""
 
576
    takes_args = ['filename?']
 
577
    def run(self, filename=None):
 
578
        """Print the branch root."""
 
579
        from branch import find_branch
 
580
        b = find_branch(filename)
 
581
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
582
 
 
583
 
 
584
class cmd_log(Command):
367
585
    """Show log of this branch.
368
586
 
369
 
    :todo: Options for utc; to show ids; to limit range; etc.
 
587
    TODO: Option to limit range.
 
588
 
 
589
    TODO: Perhaps show most-recent first with an option for last.
370
590
    """
371
 
    Branch('.').write_log(show_timezone=timezone)
372
 
 
373
 
 
374
 
def cmd_ls(revision=None, verbose=False):
 
591
    takes_args = ['filename?']
 
592
    takes_options = ['timezone', 'verbose', 'show-ids']
 
593
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
 
594
        from branch import find_branch
 
595
        b = find_branch((filename or '.'), lock_mode='r')
 
596
        if filename:
 
597
            filename = b.relpath(filename)
 
598
        bzrlib.show_log(b, filename,
 
599
                        show_timezone=timezone,
 
600
                        verbose=verbose,
 
601
                        show_ids=show_ids)
 
602
 
 
603
 
 
604
 
 
605
class cmd_touching_revisions(Command):
 
606
    """Return revision-ids which affected a particular file."""
 
607
    hidden = True
 
608
    takes_args = ["filename"]
 
609
    def run(self, filename):
 
610
        b = Branch(filename, lock_mode='r')
 
611
        inv = b.read_working_inventory()
 
612
        file_id = inv.path2id(b.relpath(filename))
 
613
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
614
            print "%6d %s" % (revno, what)
 
615
 
 
616
 
 
617
class cmd_ls(Command):
375
618
    """List files in a tree.
376
619
 
377
 
    :todo: Take a revision or remote path and list that tree instead.
 
620
    TODO: Take a revision or remote path and list that tree instead.
378
621
    """
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 = ''
 
622
    hidden = True
 
623
    def run(self, revision=None, verbose=False):
 
624
        b = Branch('.')
 
625
        if revision == None:
 
626
            tree = b.working_tree()
 
627
        else:
 
628
            tree = b.revision_tree(b.lookup_revision(revision))
 
629
 
 
630
        for fp, fc, kind, fid in tree.list_files():
 
631
            if verbose:
 
632
                if kind == 'directory':
 
633
                    kindch = '/'
 
634
                elif kind == 'file':
 
635
                    kindch = ''
 
636
                else:
 
637
                    kindch = '???'
 
638
 
 
639
                print '%-8s %s%s' % (fc, fp, kindch)
391
640
            else:
392
 
                kindch = '???'
393
 
                
394
 
            print '%-8s %s%s' % (fc, fp, kindch)
395
 
        else:
396
 
            print fp
397
 
    
398
 
    
399
 
 
400
 
def cmd_unknowns():
 
641
                print fp
 
642
 
 
643
 
 
644
 
 
645
class cmd_unknowns(Command):
401
646
    """List unknown files"""
402
 
    for f in Branch('.').unknowns():
403
 
        print quotefn(f)
404
 
 
405
 
 
406
 
 
407
 
def cmd_ignored(verbose=True):
 
647
    def run(self):
 
648
        for f in Branch('.').unknowns():
 
649
            print quotefn(f)
 
650
 
 
651
 
 
652
 
 
653
class cmd_ignore(Command):
 
654
    """Ignore a command or pattern
 
655
 
 
656
    To remove patterns from the ignore list, edit the .bzrignore file.
 
657
 
 
658
    If the pattern contains a slash, it is compared to the whole path
 
659
    from the branch root.  Otherwise, it is comapred to only the last
 
660
    component of the path.
 
661
 
 
662
    Ignore patterns are case-insensitive on case-insensitive systems.
 
663
 
 
664
    Note: wildcards must be quoted from the shell on Unix.
 
665
 
 
666
    examples:
 
667
        bzr ignore ./Makefile
 
668
        bzr ignore '*.class'
 
669
    """
 
670
    takes_args = ['name_pattern']
 
671
    
 
672
    def run(self, name_pattern):
 
673
        from bzrlib.atomicfile import AtomicFile
 
674
        import codecs
 
675
 
 
676
        b = Branch('.')
 
677
        ifn = b.abspath('.bzrignore')
 
678
 
 
679
        # FIXME: probably doesn't handle non-ascii patterns
 
680
 
 
681
        if os.path.exists(ifn):
 
682
            f = b.controlfile(ifn, 'rt')
 
683
            igns = f.read()
 
684
            f.close()
 
685
        else:
 
686
            igns = ''
 
687
 
 
688
        if igns and igns[-1] != '\n':
 
689
            igns += '\n'
 
690
        igns += name_pattern + '\n'
 
691
 
 
692
        f = AtomicFile(ifn, 'wt')
 
693
        f.write(igns)
 
694
        f.commit()
 
695
 
 
696
        inv = b.working_tree().inventory
 
697
        if inv.path2id('.bzrignore'):
 
698
            mutter('.bzrignore is already versioned')
 
699
        else:
 
700
            mutter('need to make new .bzrignore file versioned')
 
701
            b.add(['.bzrignore'])
 
702
 
 
703
 
 
704
 
 
705
class cmd_ignored(Command):
408
706
    """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))
 
707
 
 
708
    See also: bzr ignore"""
 
709
    def run(self):
 
710
        tree = Branch('.').working_tree()
 
711
        for path, file_class, kind, file_id in tree.list_files():
 
712
            if file_class != 'I':
 
713
                continue
 
714
            ## XXX: Slightly inefficient since this was already calculated
 
715
            pat = tree.is_ignored(path)
 
716
            print '%-50s %s' % (path, pat)
 
717
 
 
718
 
 
719
class cmd_lookup_revision(Command):
 
720
    """Lookup the revision-id from a revision-number
 
721
 
 
722
    example:
 
723
        bzr lookup-revision 33
 
724
    """
 
725
    hidden = True
 
726
    takes_args = ['revno']
 
727
    
 
728
    def run(self, revno):
 
729
        try:
 
730
            revno = int(revno)
 
731
        except ValueError:
 
732
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
733
 
 
734
        print Branch('.').lookup_revision(revno)
 
735
 
 
736
 
 
737
class cmd_export(Command):
 
738
    """Export past revision to destination directory.
 
739
 
 
740
    If no revision is specified this exports the last committed revision."""
 
741
    takes_args = ['dest']
 
742
    takes_options = ['revision']
 
743
    def run(self, dest, revision=None):
 
744
        b = Branch('.')
 
745
        if revision == None:
 
746
            rh = b.revision_history()[-1]
 
747
        else:
 
748
            rh = b.lookup_revision(int(revision))
 
749
        t = b.revision_tree(rh)
 
750
        t.export(dest)
 
751
 
 
752
 
 
753
class cmd_cat(Command):
 
754
    """Write a file's text from a previous revision."""
 
755
 
 
756
    takes_options = ['revision']
 
757
    takes_args = ['filename']
 
758
 
 
759
    def run(self, filename, revision=None):
 
760
        if revision == None:
 
761
            raise BzrCommandError("bzr cat requires a revision number")
 
762
        b = Branch('.')
 
763
        b.print_file(b.relpath(filename), int(revision))
 
764
 
 
765
 
 
766
class cmd_local_time_offset(Command):
 
767
    """Show the offset in seconds from GMT to local time."""
 
768
    hidden = True    
 
769
    def run(self):
 
770
        print bzrlib.osutils.local_time_offset()
 
771
 
 
772
 
 
773
 
 
774
class cmd_commit(Command):
 
775
    """Commit changes into a new revision.
 
776
 
 
777
    TODO: Commit only selected files.
 
778
 
 
779
    TODO: Run hooks on tree to-be-committed, and after commit.
 
780
 
 
781
    TODO: Strict commit that fails if there are unknown or deleted files.
 
782
    """
 
783
    takes_options = ['message', 'file', 'verbose']
 
784
    aliases = ['ci', 'checkin']
 
785
 
 
786
    def run(self, message=None, file=None, verbose=False):
 
787
        from bzrlib.commit import commit
 
788
 
 
789
        ## Warning: shadows builtin file()
 
790
        if not message and not file:
 
791
            raise BzrCommandError("please specify a commit message",
 
792
                                  ["use either --message or --file"])
 
793
        elif message and file:
 
794
            raise BzrCommandError("please specify either --message or --file")
497
795
        
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):
 
796
        if file:
 
797
            import codecs
 
798
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
799
 
 
800
        b = Branch('.')
 
801
        commit(b, message, verbose=verbose)
 
802
 
 
803
 
 
804
class cmd_check(Command):
 
805
    """Validate consistency of branch history.
 
806
 
 
807
    This command checks various invariants about the branch storage to
 
808
    detect data corruption or bzr bugs.
 
809
    """
 
810
    takes_args = ['dir?']
 
811
    def run(self, dir='.'):
 
812
        import bzrlib.check
 
813
        bzrlib.check.check(Branch(dir, find_root=False))
 
814
 
 
815
 
 
816
 
 
817
class cmd_whoami(Command):
 
818
    """Show bzr user id."""
 
819
    takes_options = ['email']
 
820
    
 
821
    def run(self, email=False):
 
822
        if email:
 
823
            print bzrlib.osutils.user_email()
 
824
        else:
 
825
            print bzrlib.osutils.username()
 
826
 
 
827
 
 
828
class cmd_selftest(Command):
520
829
    """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
 
830
    hidden = True
 
831
    def run(self):
 
832
        failures, tests = 0, 0
 
833
 
 
834
        import doctest, bzrlib.store, bzrlib.tests
 
835
        bzrlib.trace.verbose = False
 
836
 
 
837
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
838
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
839
            mf, mt = doctest.testmod(m)
 
840
            failures += mf
 
841
            tests += mt
 
842
            print '%-40s %3d tests' % (m.__name__, mt),
 
843
            if mf:
 
844
                print '%3d FAILED!' % mf
 
845
            else:
 
846
                print
 
847
 
 
848
        print '%-40s %3d tests' % ('total', tests),
 
849
        if failures:
 
850
            print '%3d FAILED!' % failures
539
851
        else:
540
852
            print
541
853
 
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():
 
854
 
 
855
 
 
856
class cmd_version(Command):
 
857
    """Show version of bzr"""
 
858
    def run(self):
 
859
        show_version()
 
860
 
 
861
def show_version():
579
862
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
580
863
    print bzrlib.__copyright__
581
864
    print "http://bazaar-ng.org/"
582
865
    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():
 
866
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
867
    print "you may use, modify and redistribute it under the terms of the GNU"
 
868
    print "General Public License version 2 or later."
 
869
 
 
870
 
 
871
class cmd_rocks(Command):
590
872
    """Statement of optimism."""
591
 
    print "it sure does!"
592
 
 
 
873
    hidden = True
 
874
    def run(self):
 
875
        print "it sure does!"
 
876
 
 
877
 
 
878
class cmd_assert_fail(Command):
 
879
    """Test reporting of assertion failures"""
 
880
    hidden = True
 
881
    def run(self):
 
882
        assert False, "always fails"
 
883
 
 
884
 
 
885
class cmd_help(Command):
 
886
    """Show help on a command or other topic.
 
887
 
 
888
    For a list of all available commands, say 'bzr help commands'."""
 
889
    takes_args = ['topic?']
 
890
    aliases = ['?']
 
891
    
 
892
    def run(self, topic=None):
 
893
        import help
 
894
        help.help(topic)
 
895
 
 
896
 
 
897
class cmd_update_stat_cache(Command):
 
898
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
899
 
 
900
    For testing only."""
 
901
    hidden = True
 
902
    def run(self):
 
903
        import statcache
 
904
        b = Branch('.')
 
905
        statcache.update_cache(b.base, b.read_working_inventory())
593
906
 
594
907
 
595
908
######################################################################
602
915
OPTIONS = {
603
916
    'all':                    None,
604
917
    'help':                   None,
 
918
    'file':                   unicode,
605
919
    'message':                unicode,
606
920
    'profile':                None,
607
921
    'revision':               int,
609
923
    'timezone':               str,
610
924
    'verbose':                None,
611
925
    'version':                None,
 
926
    'email':                  None,
612
927
    }
613
928
 
614
929
SHORT_OPTIONS = {
615
930
    'm':                      'message',
 
931
    'F':                      'file', 
616
932
    'r':                      'revision',
617
933
    'v':                      'verbose',
618
934
}
619
935
 
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
936
 
656
937
def parse_args(argv):
657
938
    """Parse command line.
678
959
    while argv:
679
960
        a = argv.pop(0)
680
961
        if a[0] == '-':
 
962
            # option names must not be unicode
 
963
            a = str(a)
681
964
            optarg = None
682
965
            if a[1] == '-':
683
966
                mutter("  got option %r" % a)
716
999
 
717
1000
 
718
1001
 
719
 
def _match_args(cmd, args):
720
 
    """Check non-option arguments match required pattern.
721
1002
 
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, [])
 
1003
def _match_argform(cmd, takes_args, args):
733
1004
    argdict = {}
734
 
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
735
 
    # all but one.
736
1005
 
737
 
    # step through args and argform, allowing appropriate 0-many matches
738
 
    for ap in argform:
 
1006
    # step through args and takes_args, allowing appropriate 0-many matches
 
1007
    for ap in takes_args:
739
1008
        argname = ap[:-1]
740
1009
        if ap[-1] == '?':
741
1010
            if args:
742
1011
                argdict[argname] = args.pop(0)
743
 
        elif ap[-1] == '*':
744
 
            assert 0
 
1012
        elif ap[-1] == '*': # all remaining arguments
 
1013
            if args:
 
1014
                argdict[argname + '_list'] = args[:]
 
1015
                args = []
 
1016
            else:
 
1017
                argdict[argname + '_list'] = None
745
1018
        elif ap[-1] == '+':
746
1019
            if not args:
747
 
                bailout("command %r needs one or more %s"
 
1020
                raise BzrCommandError("command %r needs one or more %s"
748
1021
                        % (cmd, argname.upper()))
749
1022
            else:
750
1023
                argdict[argname + '_list'] = args[:]
751
1024
                args = []
 
1025
        elif ap[-1] == '$': # all but one
 
1026
            if len(args) < 2:
 
1027
                raise BzrCommandError("command %r needs one or more %s"
 
1028
                        % (cmd, argname.upper()))
 
1029
            argdict[argname + '_list'] = args[:-1]
 
1030
            args[:-1] = []                
752
1031
        else:
753
1032
            # just a plain arg
754
1033
            argname = ap
755
1034
            if not args:
756
 
                bailout("command %r requires argument %s"
 
1035
                raise BzrCommandError("command %r requires argument %s"
757
1036
                        % (cmd, argname.upper()))
758
1037
            else:
759
1038
                argdict[argname] = args.pop(0)
760
1039
            
761
1040
    if args:
762
 
        bailout("extra arguments to command %s: %r"
763
 
                % (cmd, args))
 
1041
        raise BzrCommandError("extra argument to command %s: %s"
 
1042
                              % (cmd, args[0]))
764
1043
 
765
1044
    return argdict
766
1045
 
770
1049
    """Execute a command.
771
1050
 
772
1051
    This is similar to main(), but without all the trappings for
773
 
    logging and error handling.
 
1052
    logging and error handling.  
774
1053
    """
 
1054
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
1055
    
775
1056
    try:
776
1057
        args, opts = parse_args(argv[1:])
777
1058
        if 'help' in opts:
778
 
            # TODO: pass down other arguments in case they asked for
779
 
            # help on a command name?
780
 
            cmd_help()
 
1059
            import help
 
1060
            if args:
 
1061
                help.help(args[0])
 
1062
            else:
 
1063
                help.help()
781
1064
            return 0
782
1065
        elif 'version' in opts:
783
 
            cmd_version()
 
1066
            show_version()
784
1067
            return 0
785
 
        cmd = args.pop(0)
 
1068
        cmd = str(args.pop(0))
786
1069
    except IndexError:
787
 
        log_error('usage: bzr COMMAND\n')
788
 
        log_error('  try "bzr help"\n')
 
1070
        import help
 
1071
        help.help()
789
1072
        return 1
 
1073
          
790
1074
 
791
 
    try:
792
 
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
793
 
    except KeyError:
794
 
        bailout("unknown command " + `cmd`)
 
1075
    canonical_cmd, cmd_class = get_cmd_class(cmd)
795
1076
 
796
1077
    # global option
797
1078
    if 'profile' in opts:
801
1082
        profile = False
802
1083
 
803
1084
    # check options are reasonable
804
 
    allowed = cmd_options.get(cmd, [])
 
1085
    allowed = cmd_class.takes_options
805
1086
    for oname in opts:
806
1087
        if oname not in allowed:
807
 
            bailout("option %r is not allowed for command %r"
808
 
                    % (oname, cmd))
 
1088
            raise BzrCommandError("option '--%s' is not allowed for command %r"
 
1089
                                  % (oname, cmd))
809
1090
 
810
1091
    # mix arguments and options into one dictionary
811
 
    cmdargs = _match_args(cmd, args)
 
1092
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
1093
    cmdopts = {}
812
1094
    for k, v in opts.items():
813
 
        cmdargs[k.replace('-', '_')] = v
 
1095
        cmdopts[k.replace('-', '_')] = v
814
1096
 
815
1097
    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)
 
1098
        import hotshot, tempfile
 
1099
        pffileno, pfname = tempfile.mkstemp()
 
1100
        try:
 
1101
            prof = hotshot.Profile(pfname)
 
1102
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
1103
            prof.close()
 
1104
 
 
1105
            import hotshot.stats
 
1106
            stats = hotshot.stats.load(pfname)
 
1107
            #stats.strip_dirs()
 
1108
            stats.sort_stats('time')
 
1109
            ## XXX: Might like to write to stderr or the trace file instead but
 
1110
            ## print_stats seems hardcoded to stdout
 
1111
            stats.print_stats(20)
 
1112
            
 
1113
            return ret.status
 
1114
 
 
1115
        finally:
 
1116
            os.close(pffileno)
 
1117
            os.remove(pfname)
826
1118
    else:
827
 
        return cmd_handler(**cmdargs) or 0
 
1119
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
1120
 
 
1121
 
 
1122
def _report_exception(summary, quiet=False):
 
1123
    import traceback
 
1124
    log_error('bzr: ' + summary)
 
1125
    bzrlib.trace.log_exception()
 
1126
 
 
1127
    if not quiet:
 
1128
        tb = sys.exc_info()[2]
 
1129
        exinfo = traceback.extract_tb(tb)
 
1130
        if exinfo:
 
1131
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
1132
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
828
1133
 
829
1134
 
830
1135
 
831
1136
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)
 
1137
    import errno
839
1138
    
 
1139
    bzrlib.open_tracefile(argv)
 
1140
 
840
1141
    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
 
 
 
1142
        try:
 
1143
            try:
 
1144
                return run_bzr(argv)
 
1145
            finally:
 
1146
                # do this here inside the exception wrappers to catch EPIPE
 
1147
                sys.stdout.flush()
 
1148
        except BzrError, e:
 
1149
            quiet = isinstance(e, (BzrCommandError))
 
1150
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
1151
            if len(e.args) > 1:
 
1152
                for h in e.args[1]:
 
1153
                    # some explanation or hints
 
1154
                    log_error('  ' + h)
 
1155
            return 1
 
1156
        except AssertionError, e:
 
1157
            msg = 'assertion failed'
 
1158
            if str(e):
 
1159
                msg += ': ' + str(e)
 
1160
            _report_exception(msg)
 
1161
            return 2
 
1162
        except KeyboardInterrupt, e:
 
1163
            _report_exception('interrupted', quiet=True)
 
1164
            return 2
 
1165
        except Exception, e:
 
1166
            quiet = False
 
1167
            if (isinstance(e, IOError) 
 
1168
                and hasattr(e, 'errno')
 
1169
                and e.errno == errno.EPIPE):
 
1170
                quiet = True
 
1171
                msg = 'broken pipe'
 
1172
            else:
 
1173
                msg = str(e).rstrip('\n')
 
1174
            _report_exception(msg, quiet)
 
1175
            return 2
 
1176
    finally:
 
1177
        bzrlib.trace.close_trace()
858
1178
 
859
1179
 
860
1180
if __name__ == '__main__':
861
1181
    sys.exit(main(sys.argv))
862
 
    ##import profile
863
 
    ##profile.run('main(sys.argv)')
864